From 3949030d92d1a67bcf446706e8887bdb2521cac8 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 12:50:45 +0500 Subject: [PATCH 01/22] update schemas --- .gitignore | 1 + .../schemas/ChangeStateNotification.json | 288 +++---- .../schemas/ChangeStateOpOcc.json | 162 ++-- .../schemas/ChangeStateOpOccs.json | 21 +- .../schemas/CimSubscription.json | 204 ++--- .../schemas/CimSubscriptions.json | 25 +- .../InformationChangedNotification.json | 154 ++-- .../schemas/ManoConfigModifications.json | 169 ++--- .../schemas/ManoEntity.json | 701 ++++++++++-------- .../schemas/ManoServiceInterface.json | 372 +++++----- .../ManoServiceInterfaceModifications.json | 186 ++--- .../schemas/ManoServiceInterfaces.json | 88 +-- .../schemas/PeerEntities.json | 65 +- .../schemas/PeerEntity.json | 387 +++++----- SOL009/README.md | 2 +- 15 files changed, 1433 insertions(+), 1392 deletions(-) diff --git a/.gitignore b/.gitignore index 1b6e272e0..4655030ac 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ build/ dist/ libspecs/ +.vscode/ diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json index fc3b68c99..960b9e7d0 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json @@ -1,151 +1,151 @@ { - "description": "This type represents a Change state operation occurrence.\n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "notificationType": { - "description": "Discriminator for the different notification types. Shall be set to \"ChangeStateNotification\" for this notification type.\n", - "type": "string" - }, - "subscriptionId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "timestamp": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "changeStateOpOccId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "stateChangedTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "changeStateOperationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } + "description": "This type represents a Change state operation occurrence.\n", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timestamp", + "changeStateOpOccId", + "stateChangedTime", + "changeStateOperationState", + "managedObjectRef", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationType": { + "description": "Discriminator for the different notification types. Shall be set to \"ChangeStateNotification\" for this notification type.\n", + "type": "string" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timestamp": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "changeStateOpOccId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "stateChangedTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "changeStateOperationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] }, - "required": [ - "type", - "objectId" - ] - }, - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } }, - "_links": { - "description": "Links to resources related to this notification.\n", - "type": "object", - "properties": { - "subscription": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "objectInstance": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + "required": [ + "type", + "objectId" + ] + }, + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "_links": { + "description": "Links to resources related to this notification.\n", + "type": "object", + "properties": { + "subscription": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "changeStateOpOcc": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "objectInstance": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } } }, - "required": [ - "subscription", - "objectInstance", - "changeStateOpOcc" - ] - } - }, - "required": [ - "id", - "notificationType", - "subscriptionId", - "timestamp", - "changeStateOpOccId", - "stateChangedTime", - "changeStateOperationState", - "managedObjectRef", - "_links" - ] - } \ No newline at end of file + "changeStateOpOcc": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "subscription", + "objectInstance", + "changeStateOpOcc" + ] + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json index f9238e4d2..b0c3c9178 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json @@ -1,85 +1,85 @@ { - "description": "This type represents a Change state operation occurrence. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "operationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "stateEnteredTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } + "description": "This type represents a Change state operation occurrence. \n", + "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "managedObjectRef" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "stateEnteredTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] }, - "required": [ - "type", - "objectId" - ] - }, - "changeOperationalStateRequest": { - "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", - "type": "string", - "enum": [ - "START", - "STOP", - "RESTART" - ] - }, - "changeAdministrativeStateRequest": { - "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", - "type": "string", - "enum": [ - "LOCK", - "UNLOCK" - ] + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } }, - "operationParams": { - "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" - } + "required": [ + "type", + "objectId" + ] + }, + "changeOperationalStateRequest": { + "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", + "type": "string", + "enum": [ + "START", + "STOP", + "RESTART" + ] + }, + "changeAdministrativeStateRequest": { + "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", + "type": "string", + "enum": [ + "LOCK", + "UNLOCK" + ] }, - "required": [ - "id", - "operationState", - "stateEnteredTime", - "startTime", - "managedObjectRef" - ] - } \ No newline at end of file + "operationParams": { + "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json index 7c203be47..9f57c2454 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json @@ -1,7 +1,15 @@ -{ "type": "array", - "items": { +{ + "type": "array", + "items": { "description": "This type represents a Change state operation occurrence. \n", "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "managedObjectRef" + ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", @@ -75,13 +83,6 @@ "operationParams": { "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" } - }, - "required": [ - "id", - "operationState", - "stateEnteredTime", - "startTime", - "managedObjectRef" - ] + } } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json index 819a5d99e..1a7e924ed 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json @@ -1,113 +1,113 @@ { - "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "filter": { - "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. \n", - "type": "object", - "properties": { - "manoEntitySubscriptionFilter": { - "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", - "type": "object", - "properties": { - "manoEntityId": { + "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", + "type": "object", + "required": [ + "id", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "filter": { + "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", + "type": "object", + "properties": { + "manoEntitySubscriptionFilter": { + "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", + "type": "object", + "properties": { + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "manoServiceIds": { + "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceNames": { + "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "manoServiceInterfaceIds": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceInterfaceNames": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "consumedManoInterfaceIds": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" - }, - "manoServiceIds": { - "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceNames": { - "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "manoServiceInterfaceIds": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceInterfaceNames": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "consumedManoInterfaceIds": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - } - }, - "consumedManoInterfaceNames": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } } - } - }, - "notificationTypes": { - "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "InformationChangedNotification", - "ChangeStateNotification" - ] - } - } - } - }, - "callbackUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", + }, + "consumedManoInterfaceNames": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { "type": "string" } } } }, - "required": [ - "self" - ] + "notificationTypes": { + "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "InformationChangedNotification", + "ChangeStateNotification" + ] + } + } } }, - "required": [ - "id", - "callbackUri", - "_links" - ] - } \ No newline at end of file + "callbackUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json index 6ac082d31..a7578f88d 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json @@ -1,14 +1,20 @@ -{ "type": "array", - "items": { +{ + "type": "array", + "items": { "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", "type": "object", + "required": [ + "id", + "callbackUri", + "_links" + ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "filter": { - "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. \n", + "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", "type": "object", "properties": { "manoEntitySubscriptionFilter": { @@ -67,7 +73,7 @@ } }, "notificationTypes": { - "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n", + "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", "type": "array", "items": { "type": "string", @@ -105,13 +111,6 @@ "self" ] } - }, - "required": [ - "id", - "callbackUri", - "_links" - ] - } - - + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json index 941a4bb5c..696f45239 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json @@ -1,81 +1,81 @@ { - "description": "This type represents a notification that is sent when data about configuration and information of the NFV-MANO functional entity have been changed.\n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "notificationType": { - "description": "Discriminator for the different notification types. Shall be set to \"InformationChangedNotification\" for this notification type.\n", - "type": "string" - }, - "subscriptionId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "timeStamp": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "informationChangedTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "manoEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "changedInfo": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - }, - "_links": { - "description": "Links to resources related to this notification.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "subscription": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + "description": "This type represents a notification that is sent when data about configuration and information of the NFV-MANO functional entity have been changed.\n", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timeStamp", + "informationChangedTime", + "manoEntityId", + "changedInfo", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationType": { + "description": "Discriminator for the different notification types. Shall be set to \"InformationChangedNotification\" for this notification type.\n", + "type": "string" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timeStamp": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "informationChangedTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "changedInfo": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + }, + "_links": { + "description": "Links to resources related to this notification.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } } }, - "required": [ - "self" - ] - } - }, - "required": [ - "id", - "notificationType", - "subscriptionId", - "timeStamp", - "informationChangedTime", - "manoEntityId", - "changedInfo", - "_links" - ] - } \ No newline at end of file + "subscription": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json index 7970b361e..ea15fde7d 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json @@ -1,99 +1,86 @@ { - "description": "This type represents attribute modifications that were performed on the \"NFV-MANO entity\" resource of the producer NFV-MANO functional entity. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoConfigModificationRequest\" data structure. \n", - "type": "object", - "properties": { - "name": { - "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3\n", - "type": "string" - }, - "description": { - "description": "If present, this attribute signals modifications of the \"description\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3.\n", - "type": "string" - }, - "clockSyncs": { - "description": "If present, this attribute signals modifications of the \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", - "type": "array", - "items": { - "description": "This type represents parameters for connecting to an NTP server. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "type": { - "description": "Type of clock synchronization.\nPermitted values:\n - NTP: For Network Time Protocol (NTP) based clock synchronization.\n - OTHER: For other types of clock synchronization.\n", - "type": "string", - "enum": [ - "NTP", - "OTHER" - ] - }, - "ntpServerInfo": { - "description": "Information for the NTP based clock synchronization. Shall be present if type = \"NTP\".\n", - "type": "object", - "properties": { - "ipAddress": { - "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", - "type": "string", - "format": "IP" - }, - "hostname": { - "description": "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n", - "type": "string" - } + "description": "This type represents attribute modifications that were performed on the \"NFV-MANO entity\" resource of the producer NFV-MANO functional entity. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoConfigModificationRequest\" data structure. \n", + "type": "object", + "properties": { + "name": { + "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3\n", + "type": "string" + }, + "description": { + "description": "If present, this attribute signals modifications of the \"description\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3.\n", + "type": "string" + }, + "clockSyncs": { + "description": "If present, this attribute signals modifications of the \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents parameters for connecting to an NTP server. * NOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Type of clock synchronization.\nPermitted values:\n - NTP: For Network Time Protocol (NTP) based clock synchronization.\n - OTHER: For other types of clock synchronization.\n", + "type": "string", + "enum": [ + "NTP", + "OTHER" + ] + }, + "ntpServerInfo": { + "description": "Information for the NTP based clock synchronization. Shall be present if type = \"NTP\".\n", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type": "string", + "format": "IP" + }, + "hostname": { + "description": "Indicates the hostname of the NTP server. See note.\n", + "type": "string" } - }, - "otherClockSyncParams": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" } }, - "required": [ - "id", - "type" - ] - } - }, - "clockSyncsDeleteIds": { - "description": "If present, this attribute signals modifications of certain entries in \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", - "type": "array", - "items": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" + "otherClockSyncParams": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } } - }, - "defaultLogCompileBySizeValue": { - "description": "Unsigned integer\n", - "type": "number" - }, - "defaultLogCompileByTimerValue": { - "description": "Unsigned integer\n", - "type": "number" - }, - "manoServiceModifications": { - "description": "If present, this attribute signals modifications of the \"manoServices\" attribute array in the \"ManoEntity\", as defined in clause 5.6.2.3.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "If present, this attribute signals modification of the \"name\" attribute in the \"ManoService\".\n", - "type": "string" - }, - "description": { - "description": "If present, this attribute signals modification of the \"description\" attribute in the \"ManoService\".\n", - "type": "string" - } + } + }, + "defaultLogCompileBySizeValue": { + "description": "Unsigned integer\n", + "type": "number" + }, + "defaultLogCompileByTimerValue": { + "description": "Unsigned integer\n", + "type": "number" + }, + "manoServiceModifications": { + "description": "If present, this attribute signals modifications of the \"manoServices\" attribute array in the \"ManoEntity\", as defined in clause 5.6.2.3.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" }, - "required": [ - "id" - ] - } + "name": { + "description": "If present, this attribute signals modification of the \"name\" attribute in the \"ManoService\".\n", + "type": "string" + }, + "description": { + "description": "If present, this attribute signals modification of the \"description\" attribute in the \"ManoService\".\n", + "type": "string" + } + }, + "required": [ + "id" + ] } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json index 388b9e00e..b78f2a698 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json @@ -1,192 +1,272 @@ { - "description": "This type represents an NFV-MANO functional entity.\n", - "type": "object", - "required": [ - "id", - "type", - "name", - "description", - "provider", - "softwareVersion", - "manoConfigurableParams", - "manoApplicationState", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "type": { - "description": "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM" - ] - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "description": { - "description": "Human-readable description of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "provider": { - "description": "Information about the provider of the NFV-MANO functional entity. It typically includes the name of the provider.\n", - "type": "string" - }, - "softwareVersion": { - "description": "The version of the software of the NFV-MANO functional entity. $ref: \"../components/SOL009_schemas.yaml#/components/schemas/Version\"\n" - }, - "manoEntityComponents": { - "description": "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n", - "type": "array", - "items": { - "description": "This type represents information of a deployed component realizing part of an NFV-MANO functional entity. It is optional for the API producer to support this type. \n", - "type": "object", - "properties": { - "id": { + "description": "This type represents an NFV-MANO functional entity. * NOTE 1:\tIt shall be present when \"type\" attribute is \"NFVO\", and it shall be absent in any other case. * NOTE 2:\tIt shall be present when \"type\" attribute is \"VNFM\", and it shall be absent in any other case. * NOTE 3:\tIt shall be present when \"type\" attribute is \"VIM\", and it shall be absent in any other case. * NOTE 4:\tThe information about the NFV-MANO services offered by a specific type of NFV-MANO functional\n entity is specified by the manoServices attribute.\n* NOTE 5:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute. * NOTE 6:\tIt shall be present when \"type\" attribute is \"WIM\", and it shall be absent in any other case.\n", + "type": "object", + "required": [ + "id", + "type", + "name", + "description", + "provider", + "softwareVersion", + "manoConfigurableParams", + "manoApplicationState", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "type": { + "description": "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\t The NFV-MANO functional entity is a VIM.\n - WIM The NFV-MANO functional entity is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM" + ] + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "provider": { + "description": "Information about the provider of the NFV-MANO functional entity. It typically includes the name of the provider.\n", + "type": "string" + }, + "softwareVersion": { + "description": "A version.\n", + "type": "string" + }, + "manoEntityComponents": { + "description": "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. See note 5.\n", + "type": "array", + "items": { + "description": "This type represents information of a deployed component realizing part of an NFV-MANO functional entity. It is optional for the API producer to support this type. \n", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "manoServiceIds": { + "description": "References to the NFV-MANO services that depend on the NFV-MANO functional entity component. The identifier of the ManoService is referred. A service may depend on multiple components. Multiple services may depend on the same component.\n", + "type": "array", + "items": { "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", "type": "string" - }, - "manoServiceIds": { - "description": "References to the NFV-MANO services that depend on the NFV-MANO functional entity component. The identifier of the ManoService is referred. A service may depend on multiple components. Multiple services may depend on the same component.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } } + } + } + } + }, + "manoServices": { + "description": "Information about the NFV-MANO services provided by the NFV-MANO functional entity.\n", + "type": "array", + "items": { + "description": "This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity. * NOTE:\tA cardinality greater than one supports having different interface versions or api Endpoints\n to be used for accessing the same instance of an NFV-MANO service.\n", + "type": "object", + "required": [ + "id", + "name", + "description", + "manoServiceInterfaceIds", + "_links" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" }, - "required": [ - "id" + "name": { + "description": "Human-readable name of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "manoServiceInterfaceIds": { + "description": "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. See note\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "minItems": 1 + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "manoServiceInterfaces": { + "description": "Link to the \"individual NFV-MANO service interface\" resources with information about the associated interfaces to the NFV-MANO service.\n", + "type": "array", + "items": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "minItems": 1 + } + }, + "required": [ + "manoServiceInterfaces" + ] + } + } + } + }, + "manoConfigurableParams": { + "description": "# Warning: No definition found in the document ManoConfigurableParams\n" + }, + "manoApplicationState": { + "description": "Information and current values of the NFV-MANO functional entityΓÇÖs application state. \n", + "type": "object", + "required": [ + "operationalState", + "administrativeState", + "usageState" + ], + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" ] } - }, - "manoServices": { - "description": "Information about the NFV-MANO services provided by the NFV-MANO functional entity.\n", - "type": "array", - "items": { - "description": "This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity.\n", + } + }, + "nfvoSpecificInfo": { + "description": "This type represents information attributes specific to an NFVO entity, and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined.\n", + "type": "object", + "required": [ + "supportedVnfdFormats", + "supportedNsdFormats" + ], + "properties": { + "maxOnboardedNsdNum": { + "description": "Maximum number of NSDs that can be on-boarded on the NFVO. See note 2.\n", + "type": "integer" + }, + "maxOnboardedVnfPkgNum": { + "description": "Maximum number of VNF Packages that can be on-boarded on the NFVO. See note 2.\n", + "type": "integer" + }, + "supportedVnfdFormats": { + "description": "Supported VNFD data formats.\n", "type": "object", "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" + "vnfdFormat": { + "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] }, - "name": { - "description": "Human-readable name of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "standardVersion": { + "description": "A version.\n", "type": "string" + } + }, + "required": [ + "vnfdFormat", + "standardVersion" + ] + }, + "supportedNsdFormats": { + "description": "Supported NSD data formats.\n", + "type": "object", + "properties": { + "nsdFormat": { + "description": "Name of the NSD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] }, - "description": { - "description": "Human-readable description of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "standardVersion": { + "description": "A version.\n", "type": "string" - }, - "manoServiceInterfaceIds": { - "description": "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "minItems": 1 - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "manoServiceInterfaces": { - "description": "Link to the \"individual NFV-MANO service interface\" resources with information about the associated interfaces to the NFV-MANO service.\n", - "type": "array", - "items": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "minItems": 1 - } - }, - "required": [ - "manoServiceInterfaces" - ] } }, "required": [ - "id", - "name", - "description", - "manoServiceInterfaceIds", - "_links" + "nsdFormat", + "standardVersion" ] } - }, - "manoConfigurableParams": { - "description": "# Warning: No definition found in the document ManoConfigurableParams\n" - }, - "manoApplicationState": { - "description": "Information and current values of the NFV-MANO functional entity’s application state. \n", - "type": "object", - "required": [ - "operationalState", - "administrativeState", - "usageState" - ], - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } - } - }, - "nfvoSpecificInfo": { - "description": "This type represents information attributes specific to an NFVO entity, and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. \n", - "type": "object", - "properties": { - "maxOnboardedNsdNum": { - "description": "Maximum number of NSDs that can be on-boarded on the NFVO. \nNOTE: If this attribute is not present, the value of this parameter is undefined.\n", - "type": "integer" - }, - "maxOnboardedVnfPkgNum": { - "description": "Maximum number of VNF Packages that can be on-boarded on the NFVO. \nNOTE: If this attribute is not present, the value of this parameter is undefined.\n", - "type": "integer" + } + }, + "vnfmSpecificInfo": { + "description": "This type represents information attributes specific to a VNFM entity, and that can be relevant to more than one NFV-MANO service offered by a VNFM entity. * NOTE:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n", + "type": "object", + "required": [ + "resoruceMgmtModeSupport", + "managedVnfInstanceInfos", + "supportedVnfdFormats" + ], + "properties": { + "resoruceMgmtModeSupport": { + "description": "The supported resource management modes of the VNFM.\nPermitted values:\n - DIRECT: The VNFM supports direct mode only.\n - INDIRECT: The VNFM supports indirect mode only.\n - BOTH: The VNFM supports both direct and indirect mode.\n", + "type": "string", + "enum": [ + "DIRECT", + "INDIRECT", + "BOTH" + ] + }, + "managedVnfInstanceInfos": { + "description": "The kinds of VNF instances that can be managed, e.g. to determine the compatibility of a VNF with certain VNFM according to the vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).\n", + "type": "array", + "items": { + "type": "string" }, - "supportedVnfdFormats": { - "description": "Supported VNFD data formats.\n", + "minItems": 1 + }, + "supportedVnfdFormats": { + "description": "Supported VNFD data formats.\n", + "type": "array", + "items": { "type": "object", "properties": { "vnfdFormat": { @@ -207,169 +287,148 @@ "standardVersion" ] }, - "supportedNsdFormats": { - "description": "Supported NSD data formats.\n", - "type": "object", - "properties": { - "nsdFormat": { - "description": "Name of the NSD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } + "minItems": 1 + } + } + }, + "vimSpecificInfo": { + "description": "This type represents information attributes specific to a VIM entity, and that can be relevant to more than one NFV-MANO service offered by a VIM entity.\n", + "type": "object" + }, + "wimSpecificInfo": { + "description": "This type represents information attributes specific to a WIM entity, and that can be relevant to more than one NFV MANO service offered by a WIM entity.\n", + "type": "object", + "required": [ + "maxMscsNums", + "maxMsncNum", + "mscsLayerProtocolSupport" + ], + "properties": { + "maxMscsNums": { + "description": "Maximum number of MSCS that the WIM can manage.\n", + "type": "object", + "required": [ + "numMscs" + ], + "properties": { + "numMscs": { + "description": "Maximum number of MSCS.\n", + "type": "integer" }, - "required": [ - "nsdFormat", - "standardVersion" - ] + "criteriaNumMscs": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } } }, - "required": [ - "supportedVnfdFormats", - "supportedNsdFormats" - ] - }, - "vnfmSpecificInfo": { - "description": "This type represents information attributes specific to a VNFM entity, and that can be relevant to more than one NFV-MANO service offered by a VNFM entity.\n", - "type": "object", - "properties": { - "resoruceMgmtModeSupport": { - "description": "The supported resource management modes of the VNFM.\nPermitted values:\n - DIRECT: The VNFM supports direct mode only.\n - INDIRECT: The VNFM supports indirect mode only.\n - BOTH: The VNFM supports both direct and indirect mode.\n", - "type": "string", - "enum": [ - "DIRECT", - "INDIRECT", - "BOTH" - ] - }, - "managedVnfInstanceInfos": { - "description": "The kinds of VNF instances that can be managed, e.g. to determine the compatibility of a VNF with certain VNFM according to the vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - }, - "supportedVnfdFormats": { - "description": "Supported VNFD data formats.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "vnfdFormat": { - "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } - }, - "required": [ - "vnfdFormat", - "standardVersion" - ] + "maxMsncNum": { + "description": "Maximum number of MSNC that the WIM can manage\n", + "type": "object", + "required": [ + "numMsnc" + ], + "properties": { + "numMsnc": { + "description": "Maximum number of MSNC..\n", + "type": "integer" }, - "minItems": 1 + "criteriaNumMsnc": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } } }, - "required": [ - "resoruceMgmtModeSupport", - "managedVnfInstanceInfos", - "supportedVnfdFormats" - ] - }, - "vimSpecificInfo": { - "description": "This type represents information attributes specific to a VIM entity, and that can be relevant to more than one NFV-MANO service offered by a VIM entity.\n", - "type": "object" - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "required": [ - "self", - "manoServiceInterfaces", - "peerEntities", - "changeState", - "changeStateOpOccs" - ], - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + "mscsLayerProtocolSupport": { + "description": "List of protocols of particular layers used to realize an MSCS that are supported by the WIM.\nPermitted values:\n - EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432.\n - EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214.\n - VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified\n in IETF RFC 4761 and IETF RFC.\n - VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2\n Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074.\n - VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074.\n - BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364.\n", + "type": "string", + "enum": [ + "EVPN_BGP_MPLS", + "EVPN_VPWS", + "VPLS_BGP", + "VPLS_LDP_L2TP", + "VPWS_LDP_L2TP", + "BGP_IP_VPN" + ] + } + } + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "required": [ + "self", + "manoServiceInterfaces", + "peerEntities", + "changeState", + "changeStateOpOccs" + ], + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "manoServiceInterfaces": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "manoServiceInterfaces": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "peerEntities": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "peerEntities": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "changeState": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "changeState": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "changeStateOpOccs": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "changeStateOpOccs": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } } } } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json index 16b7cc3fe..bcedca867 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json @@ -1,215 +1,215 @@ { - "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "providerSpecificApiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" + "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "providerSpecificApiVersion", + "apiVersion", + "apiEndpoint", + "supportedOperations", + "interfaceState" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "providerSpecificApiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Exposed API endpoint of the interface.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } }, - "apiEndpoint": { - "description": "Exposed API endpoint of the interface.\n", + "required": [ + "apiUri" + ] + }, + "maxConcurrentIntOpNumber": { + "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", + "type": "integer" + }, + "supportedOperations": { + "description": "Information about supported operations of this interface.\n", + "type": "array", + "items": { "type": "object", "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "operationName": { + "description": "Name of the operation supported on the interface.\n", "type": "string" }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" + "maxConcurrentOpNumber": { + "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", + "type": "integer" } }, "required": [ - "apiUri" + "operationName" ] }, - "maxConcurrentIntOpNumber": { - "description": "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n", - "type": "integer" - }, - "supportedOperations": { - "description": "Information about supported operations of this interface.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "operationName": { - "description": "Name of the operation supported on the interface.\n", - "type": "string" - }, - "maxConcurrentOpNumber": { - "description": "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n", - "type": "integer" - } - }, - "required": [ - "operationName" + "minItems": 1 + }, + "interfaceState": { + "description": "State of the NFV-MANO service interface.\n", + "properties": { + "operationalState": { + "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING" ] }, - "minItems": 1 + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + } }, - "interfaceState": { - "description": "State of the NFV-MANO service interface.\n", - "properties": { - "operationalState": { - "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "required": [ + "operationalState", + "administrativeState", + "usageState" + ] + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { "type": "string", "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" + "TLS_TUNNEL", + "OAUTH2" ] }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } + "minItems": 1 }, - "required": [ - "operationalState", - "administrativeState", - "usageState" - ] - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. \n", - "type": "object", - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "webFingerHost" - ] - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "authServerId" - ] - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", "type": "string" - }, - "minItems": 1 + } } }, - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ] - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.", - "type": "array", - "items": { + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", "type": "string" - }, - "minItems": 1 + } } }, - "required": [ - "tlsTunnelCipherSuites" - ] + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } } }, - "required": [ - "authType", - "oauthServerInfo" - ] - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } } }, - "required": [ - "id", - "name", - "type", - "standardVersion", - "providerSpecificApiVersion", - "apiVersion", - "apiEndpoint", - "supportedOperations", - "interfaceState" - ] - } \ No newline at end of file + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json index 080fc11f2..696a8c11e 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json @@ -1,105 +1,105 @@ { - "description": "This type represents attribute modifications that were performed on an Individual NFV-MANO service interface\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoServiceInterfaceModificationRequest\" data structure. If applicable, additional attributes of the \"ManoServiceInterface\" data structure that were modified implicitly shall also be provided. \n", - "type": "object", - "properties": { - "name": { - "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoServiceInterface\", as defined in clause 5.6.2.11.\n", - "type": "string" - }, - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. \n", - "type": "object", - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 + "description": "This type represents attribute modifications that were performed on an Individual NFV-MANO service interface\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoServiceInterfaceModificationRequest\" data structure. If applicable, additional attributes of the \"ManoServiceInterface\" data structure that were modified implicitly shall also be provided. * NOTE:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all\n to the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided\n in a response message.\n", + "type": "object", + "properties": { + "name": { + "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoServiceInterface\", as defined in clause 5.6.2.11.\n", + "type": "string" + }, + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "webFingerHost" - ] - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "authServerId" - ] - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", "type": "string" - }, - "minItems": 1 + } } }, - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ] - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.", - "type": "array", - "items": { + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", "type": "string" - }, - "minItems": 1 + } } }, - "required": [ - "tlsTunnelCipherSuites" - ] + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } } }, - "required": [ - "authType", - "oauthServerInfo" - ] - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } } + }, + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json index ad71446bf..5ba68faae 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json @@ -1,7 +1,19 @@ -{ "type": "array", - "items": { - "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. \n", +{ + "type": "array", + "items": { + "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "providerSpecificApiVersion", + "apiVersion", + "apiEndpoint", + "supportedOperations", + "interfaceState" + ], "properties": { "id": { "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", @@ -53,7 +65,7 @@ ] }, "maxConcurrentIntOpNumber": { - "description": "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n", + "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", "type": "integer" }, "supportedOperations": { @@ -67,7 +79,7 @@ "type": "string" }, "maxConcurrentOpNumber": { - "description": "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n", + "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", "type": "integer" } }, @@ -115,8 +127,12 @@ ] }, "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. \n", + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], "properties": { "authType": { "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", @@ -133,53 +149,53 @@ "oauthServerInfo": { "description": "OAuth 2.0 authorization server information and configuration.\n", "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], "properties": { "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", "type": "object", + "required": [ + "webFingerHost" + ], "properties": { "webFingerHost": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } - }, - "required": [ - "webFingerHost" - ] + } }, "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", + "description": "Configuration data used to setup the authorization server identifier. See note.\n", "type": "object", + "required": [ + "authServerId" + ], "properties": { "authServerId": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } - }, - "required": [ - "authServerId" - ] + } }, "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", "type": "array", "items": { - "type": "string" - }, - "minItems": 1 + "type": "string", + "minItems": 1 + } } - }, - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ] + } }, "tlsTunnelInfo": { "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", "type": "object", "properties": { "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.", + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", "type": "array", "items": { "type": "string" @@ -191,28 +207,12 @@ "tlsTunnelCipherSuites" ] } - }, - "required": [ - "authType", - "oauthServerInfo" - ] + } }, "metadata": { "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", "type": "object" } - }, - "required": [ - "id", - "name", - "type", - "standardVersion", - "providerSpecificApiVersion", - "apiVersion", - "apiEndpoint", - "supportedOperations", - "interfaceState" - ] + } } - } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json index c7e85d04b..75811a050 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json @@ -1,7 +1,15 @@ -{ "type": "array", - "items": { - "description": "This type represents an individual peer entity. \n", +{ + "type": "array", + "items": { + "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", "type": "object", + "required": [ + "id", + "peerEntityId", + "name", + "type", + "peerEntityState" + ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", @@ -16,7 +24,7 @@ "type": "string" }, "type": { - "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n", + "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", "type": "string", "enum": [ "NFVO", @@ -24,7 +32,8 @@ "VIM", "WIM", "EM", - "OSS" + "OSS", + "WIM" ] }, "description": { @@ -32,16 +41,20 @@ "type": "string" }, "consumedManoInterfaces": { - "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "array", - "items": { - "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. \n", + "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "apiVersion", + "apiEndpoint" + ], "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, "name": { "description": "Human-readable name of the NFV-MANO interface.\n", "type": "string" @@ -84,7 +97,7 @@ ] }, "securityInfo": { - "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity.\n", + "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", "type": "object", "required": [ "authType", @@ -108,7 +121,7 @@ "type": "object", "properties": { "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", "type": "object", "required": [ "webFingerHost" @@ -122,7 +135,7 @@ } }, "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", + "description": "Configuration data used to setup the authorization server identifier. See note.\n", "type": "object", "required": [ "authServerId" @@ -161,15 +174,7 @@ } } } - }, - "required": [ - "id", - "name", - "type", - "standardVersion", - "apiVersion", - "apiEndpoint" - ] + } } }, "peerEntityState": { @@ -202,14 +207,6 @@ "administrativeState" ] } - }, - "required": [ - "id", - "peerEntityId", - "name", - "type", - "peerEntityState" - ] + } } - } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json index cbf0cbe24..e168b2a11 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json @@ -1,212 +1,209 @@ { - "description": "This type represents an individual peer entity. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "peerEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM", - "WIM", - "EM", - "OSS" - ] - }, - "description": { - "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "consumedManoInterfaces": { - "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "array", - "items": { - "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO interface.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", + "type": "object", + "required": [ + "id", + "peerEntityId", + "name", + "type", + "peerEntityState" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "peerEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM", + "EM", + "OSS", + "WIM" + ] + }, + "description": { + "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "consumedManoInterfaces": { + "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "apiVersion", + "apiEndpoint" + ], + "properties": { + "name": { + "description": "Human-readable name of the NFV-MANO interface.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" }, - "required": [ - "apiUri" - ] + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } }, - "securityInfo": { - "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 + "required": [ + "apiUri" + ] + }, + "securityInfo": { + "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", "type": "string", - "minItems": 1 + "format": "uri" } } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", "type": "string", - "minItems": 1 + "format": "uri" } } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } } } } } - }, - "required": [ - "id", - "name", - "type", - "standardVersion", - "apiVersion", - "apiEndpoint" - ] - } - }, - "peerEntityState": { - "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", - "type": "object", - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] } - }, - "required": [ - "operationalState", - "administrativeState" - ] + } } }, - "required": [ - "id", - "peerEntityId", - "name", - "type", - "peerEntityState" - ] - } \ No newline at end of file + "peerEntityState": { + "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", + "type": "object", + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + } + }, + "required": [ + "operationalState", + "administrativeState" + ] + } + } +} \ No newline at end of file diff --git a/SOL009/README.md b/SOL009/README.md index bb1592d77..68272f4f0 100644 --- a/SOL009/README.md +++ b/SOL009/README.md @@ -2,5 +2,5 @@ This folder includes the NFV API conformance test descriptions for NFV SOL009 APIs. -The reference spec version is v3.3.1: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf +The reference spec version is v3.5.1: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_nfv-sol009v030501p.pdf -- GitLab From d92c8edd2ee4524824523b78057d1593ce821518 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 14:14:47 +0500 Subject: [PATCH 02/22] update document number to v3.5.1 --- .../ChangeInterfaceStateTask.robot | 14 +++---- .../ChangeNFVMANOEntityStateTask.robot | 12 +++--- .../ChangeStateOperationOccurrences.robot | 32 ++++++++-------- .../IndividualNFVMANOServiceInterface.robot | 18 ++++----- .../IndividualPeerEntity.robot | 18 ++++----- ...vidualStateChangeOperationOccurrence.robot | 14 +++---- .../IndividualSubscription.robot | 14 +++---- .../NFVMANOEntity.robot | 16 ++++---- .../NFVMANOServiceInterfaces.robot | 32 ++++++++-------- .../NotificationEndpoint.robot | 8 ++-- .../Notifications.robot | 18 ++++----- .../PeerEntities.robot | 38 +++++++++---------- .../Subscriptions.robot | 24 ++++++------ 13 files changed, 129 insertions(+), 129 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeInterfaceStateTask.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeInterfaceStateTask.robot index 4d58d8b4b..1ec2b5161 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeInterfaceStateTask.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeInterfaceStateTask.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Change interface state task ... Test title: POST Change interface state task ... Test objective: The objective is send put request to change the state of the NFV-MANO service interface produced by the NFV-MANO functional entity ... Pre-conditions: none - ... Reference: clause 5.5.12.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: interface status changed @@ -27,7 +27,7 @@ POST Change interface state task - Conflict ... Test title: POST Change interface state task - Conflict ... Test objective: The objective is to test that request to cchange the state of the NFV-MANO service interface produced by the NFV-MANO functional entity failed due to a conflict with the state of the NFV-MANO entity resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -40,7 +40,7 @@ GET Change interface state task - Method not implemented ... Test title: GET Change interface state task - Method not implemented ... Test objective: The objective is to test that GET method is not allowed to retrieve the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -52,7 +52,7 @@ PUT Change interface state task - Conflict - Method not implemented ... Test title: PUT Change interface state task - Conflict - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to update the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -64,7 +64,7 @@ PATCH Change interface state task - Conflict - Method not implemented ... Test title: PATCH Change interface state task - Conflict - Method not implemented ... Test objective: The objective is to test that PATCH method is not allowed to update the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -76,7 +76,7 @@ DELETE Change interface state task - Conflict - Method not implemented ... Test title: DELETE Change interface state task - Conflict - Method not implemented ... Test objective: The objective is to test that DELETE method is not allowed to delete the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeNFVMANOEntityStateTask.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeNFVMANOEntityStateTask.robot index e450afa03..594da210d 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeNFVMANOEntityStateTask.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeNFVMANOEntityStateTask.robot @@ -12,7 +12,7 @@ POST NFV-MANO functional entity application state change ... Test title: POST NFV-MANO functional entity application state change ... Test objective: The objective is to request state change of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: entity status changed @@ -26,7 +26,7 @@ POST NFV-MANO functional entity application state change - Conflict ... Test title: POST NFV-MANO functional entity application state change - Conflict ... Test objective: The objective is to test that request to change the state of the NFV-MANO functional entity application fails due to a conflict with the state of the NFV-MANO entity resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -39,7 +39,7 @@ GET NFV-MANO functional entity application state change - Method not implemented ... Test title: GET NFV-MANO functional entity application state change - Method not implemented ... Test objective: The objective is to test that GET method is not allowed to retrieve the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -51,7 +51,7 @@ PUT NFV-MANO functional entity application state change - Method not implemented ... Test title: PUT NFV-MANO functional entity application state change - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to update the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -63,7 +63,7 @@ PATCH NFV-MANO functional entity application state change - Method not implement ... Test title: PATCH NFV-MANO functional entity application state change - Method not implemented ... Test objective: The objective is to test that PATCH method is not allowed to update the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -75,7 +75,7 @@ DELETE NFV-MANO functional entity application state change - Method not implemen ... Test title: DELETE NFV-MANO functional entity application state change - Method not implemented ... Test objective: The objective is to test that DELETE method is not allowed to delete the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeStateOperationOccurrences.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeStateOperationOccurrences.robot index 7f60fe749..564e36cfd 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeStateOperationOccurrences.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeStateOperationOccurrences.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Change State Operation Occurrences - Method not implemented ... Test title: POST Change State Operation Occurrences - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET Change State Operation Occurrences ... Test title: GET Change State Operation Occurrences ... Test objective: The objective is to query status information about multiple change state operation occurrences, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET Change State Operation Occurrences - invalid attribute-based filter ... Test title: GET Change State Operation Occurrences - invalid attribute-based filter ... Test objective: The objective is to test that the retrieval of Change State Operation Occurrences fails when using invalid attribute-based filter, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -51,7 +51,7 @@ GET Change State Operation Occurrences - invalid attribute selector ... Test title: GET Change State Operation Occurrences - invalid attribute selector ... Test objective: The objective is to test that the retrieval of Change State Operation Occurrences fails when using invalid attribute selector, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -64,7 +64,7 @@ GET Change State Operation Occurrences - Bad Request Response too Big ... Test title: GET Change State Operation Occurrences - Bad Request Response too Big ... Test objective: The objective is to test that the retrieval of Change State Operation Occurrences fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -77,7 +77,7 @@ GET Change State Operation Occurrences with attribute-based filter ... Test title: GET Change State Operation Occurrences with attribute-based filter ... Test objective: The objective is to query status information about multiple change state operation occurrences with attribute filters, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -90,7 +90,7 @@ GET Change State Operation Occurrences with "all_fields" attribute selector ... Test title: GET Change State Operation Occurrences with "all_fields" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrences with "all_fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -103,7 +103,7 @@ GET Change State Operation Occurrences with "exclude_default" attribute selector ... Test title: GET Change State Operation Occurrence with "exclude_default" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrence with "exclude_default" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -116,7 +116,7 @@ GET Change State Operation Occurrences with "fields" attribute selector ... Test title: GET Change State Operation Occurrences with "fields" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrences with fields attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -129,7 +129,7 @@ GET Change State Operation Occurrences with "exclude_fields" attribute selector ... Test title: GET Change State Operation Occurrences with "exclude_fields" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrences with "exclude_fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -142,7 +142,7 @@ GET Change State Operation Occurrences with Paged Response ... Test title: GET Change State Operation Occurrence with Paged Response ... Test objective: The objective is to query Change State Operation Occurrence to get Paged Response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -155,7 +155,7 @@ GET Change State Operation Occurrences with "fields" and "exclude_default" attri ... Test title: GET Change State Operation Occurrences with "fields" and "exclude_default" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrences with fields and exclude default attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -168,7 +168,7 @@ PUT Change State Operation Occurrences - Method not implemented ... Test title: PUT Change State Operation Occurrences - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -180,7 +180,7 @@ PATCH Change State Operation Occurrences - Method not implemented ... Test title: PATCH Change State Operation Occurrences - Method not implemented ... Test objective: The objective is to test that PATCH method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -192,7 +192,7 @@ DELETE Change State Operation Occurrences - Method not implemented ... Test title: DELETE Change State Operation Occurrences - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualNFVMANOServiceInterface.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualNFVMANOServiceInterface.robot index caea555e4..68b51c9e8 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualNFVMANOServiceInterface.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualNFVMANOServiceInterface.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Individual NFV-MANO Service Interface - Method not implemented ... Test title: POST Individual NFV-MANO Service Interface - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET Individual NFV-MANO Service Interface ... Test title: GET Individual NFV-MANO Service Interface ... Test objective: The objective is to query status information about an NFV-MANO service interface of the producer NFV-MANO functional entity by reading an "Individual NFV-MANO service interface" resource, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET Individual NFV-MANO Service Interface - Not Found ... Test title: GET Individual NFV-MANO Service Interface - Not Found ... Test objective: The objective is to test the retrieval of information about an NFV-MANO service interface of the producer NFV-MANO functional entity by reading an "Individual NFV-MANO service interface" resource fails when the resource is not present. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -51,7 +51,7 @@ PUT Individual NFV-MANO Service Interface - Method not implemented ... Test title: PUT Individual NFV-MANO Service Interface - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -63,7 +63,7 @@ PATCH Individual NFV-MANO Service Interface ... Test title: PATCH Individual NFV-MANO Service Interface ... Test objective: This method modifies the Individual NFV-MANO Service Interface resource, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: Individual NFV-MANO Service Interface resource is already created. - ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The Individual NFV-MANO Service Interface is modified by the operation @@ -76,7 +76,7 @@ PATCH Individual NFV-MANO Service Interface - Conflict ... Test title: PATCH Individual NFV-MANO Service Interface - Conflict ... Test objective: The objective is to test that the modification of the Individual NFV-MANO Service Interface resource failed due to a conflict with the state of the Individual NFV-MANO Service Interface resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: Individual NFV-MANO Service Interface resource is already created. - ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The Individual NFV-MANO Service Interface is not modified by the operation @@ -89,7 +89,7 @@ PATCH Individual NFV-MANO Service Interface - PreCondition Failed ... Test title: PATCH Individual NFV-MANO Service Interface - PreCondition Failed ... Test objective: The objective is to test that the modification of the Individual NFV-MANO Service Interface resource failed because precondition given in an HTTP request header is not fulfilled and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: Individual NFV-MANO Service Interface resource is already created. - ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The Individual NFV-MANO Service Interface is not modified by the operation @@ -102,7 +102,7 @@ DELETE Individual NFV-MANO Service Interface - Method not implemented ... Test title: DELETE Individual NFV-MANO Service Interface - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualPeerEntity.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualPeerEntity.robot index f6e5a7225..5e8d57e00 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualPeerEntity.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualPeerEntity.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Individual Peer Entity - Method not implemented ... Test title: POST Individual Peer Entity - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.14.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET Individual Peer Entity ... Test title: GET Individual Peer Entity ... Test objective: The objective is to retrieves information and configuration hold in the producer NFV-MANO functional entity with regards to a peer entity by reading an individual peer entity resource ... Pre-conditions: none - ... Reference: clause 5.5.14.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET Individual Peer Entity - Not Found ... Test title: GET Individual Peer Entity - Not Found ... Test objective: The objective is to test the retrieval of information and configuration hold in the producer NFV-MANO functional entity with regards to a peer entity by reading an individual peer entity resource fails when the resource is not present. ... Pre-conditions: none - ... Reference: clause 5.5.14.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -50,7 +50,7 @@ PUT Individual Peer Entity - Method not implemented ... Test title: PUT Individual Peer Entity - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.14.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -62,7 +62,7 @@ PATCH Individual Peer Entity ... Test title: PATCH Individual Peer Entity ... Test objective: This method modifies configuration and information of the producer NFV-MANO functional entity with regards to a peer functional entity by updating the corresponding "Individual peer entity" resource. ... Pre-conditions: At least one Peer Entity resource is created - ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: Peer Entity Resource is modified by the operation @@ -75,7 +75,7 @@ PATCH Individual Peer Entity - Conflict ... Test title: PATCH Individual Peer Entity - Conflict ... Test objective: The objective is to test that the modification of configuration and information of the producer NFV-MANO functional entity with regards to a peer functional entity by updating the corresponding "Individual peer entity" resource failed due to a conflict with the state of the Individual Peer Entity resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity resource is created - ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: Peer Entity Resource is not modified by the operation @@ -88,7 +88,7 @@ PATCH Individual Peer Entity - PreCondition Failed ... Test title: PATCH Individual Peer Entity - PreCondition Failed ... Test objective: The objective is to test that the modification of the Individual Peer Entity resource failed because precondition given in an HTTP request header is not fulfilled and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity resource is created - ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: Peer Entity Resource is not modified by the operation @@ -101,7 +101,7 @@ DELETE Individual Peer Entity - Method not implemented ... Test title: DELETE Individual Peer Entity - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.14.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualStateChangeOperationOccurrence.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualStateChangeOperationOccurrence.robot index c9797ea9e..cc058006b 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualStateChangeOperationOccurrence.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualStateChangeOperationOccurrence.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Individual Change State Operation Occurrence - Method not implemented ... Test title: POST Individual Change State Operation Occurrence - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET Individual Change State Operation Occurrence ... Test title: GET Individual Change State Operation Occurrence ... Test objective: The objective is to query status information about Individual change state operation occurrence. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET Individual Change State Operation Occurrence - Not Found ... Test title: GET Individual Change State Operation Occurrence - Not Found ... Test objective: The objective is to test the retrieval of information about individual change state operation occurence fails when the resource is not present. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -50,7 +50,7 @@ PUT Individual Change State Operation Occurrence - Method not implemented ... Test title: PUT Individual Change State Operation Occurrence - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -62,7 +62,7 @@ PATCH Individual Change State Operation Occurrence - Method not implemented ... Test title: PATCH Individual Change State Operation Occurrence - Method not implemented ... Test objective: The objective is to test that PATCH method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -74,7 +74,7 @@ DELETE Individual Change State Operation Occurrence - Method not implemented ... Test title: DELETE Individual Change State Operation Occurrence - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualSubscription.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualSubscription.robot index e20248234..e01857ac8 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualSubscription.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualSubscription.robot @@ -12,7 +12,7 @@ GET Individual Subscription ... Test title: GET Individual Subscription ... Test objective: The objective is to test the retrieval of individual subscription and perform a JSON schema and content validation of the returned subscription data structure ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.5.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -26,7 +26,7 @@ GET Individual Subscription - invalid resource identifier ... Test title: GET Individual Subscription - invalid resource identifier ... Test objective: The objective is to test that the retrieval of an individual subscription fails when using an invalid resource identifier ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.5.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ DELETE Individual Subscription ... Test title: DELETE Individual Subscription ... Test objective: The objective is to test the deletion of an individual subscription ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.5.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The resource is not available anymore in the NFV-MANO @@ -51,7 +51,7 @@ DELETE Individual Subscription - invalid resource identifier ... Test title: DELETE Individual Subscription - invalid resource identifier ... Test objective: The objective is to test that the deletion of an individual subscription fails when using an invalid resource identifier ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.5.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -63,7 +63,7 @@ POST Individual Subscription - Method not implemented ... Test title: POST Individual Subscription - Method not implemented ... Test objective: The objective is to test that POST method is not allowed to create a new Subscription ... Pre-conditions: none - ... Reference: clause 5.5.5.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -75,7 +75,7 @@ PUT Individual Subscription - Method not implemented ... Test title: PUT Individual Subscription - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to update an existing subscription ... Pre-conditions: none - ... Reference: clause 5.5.5.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -87,7 +87,7 @@ PATCH Individual Subscription - Method not implemented ... Test title: PATCH Individual Subscription - Method not implemented ... Test objective: The objective is to test that PATCH method is not allowed to modify an existing subscription ... Pre-conditions: none - ... Reference: clause 5.5.5.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOEntity.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOEntity.robot index 74a29921b..07bb06953 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOEntity.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOEntity.robot @@ -13,7 +13,7 @@ POST NFV-MANO entity - Method not implemented ... Test title: POST NFV-MANO entity - Method not implemented ... Test objective: The objective is to test that POST method is not allowed to create an NFV-MANO Entity. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET NFV-MANO entity ... Test title: Get NFV-MANO entity ... Test objective: The objective is to test the retrieval of information about an NFV-MANO functional entity by reading the NFV-MANO entity resource and perform a JSON schema and content validation of the collected job data structure. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET NFV-MANO entity - Not Found ... Test title: Get NFV-MANO entity - Not Found ... Test objective: The objective is to test the retrieval of information about an NFV-MANO functional entity by reading the NFV-MANO entity resource fails when the resource is not present. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -50,7 +50,7 @@ PUT NFV-MANO entity - Method not implemented ... Test title: PUT NFV-MANO entity - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to update an NFV-MANO Entity. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -62,7 +62,7 @@ PATCH NFV-MANO entity ... Test title: PATCH NFV-MANO entity ... Test objective: The objective is to test that PATCH method modifies the NFV-MANO entity resource and perform a JSON schema and content validation of the modified response. ... Pre-conditions: NFV-MANO entity resource is already created. - ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The NFV-MANO entity is modified by the operation @@ -75,7 +75,7 @@ PATCH NFV-MANO entity - Conflict ... Test title: PATCH NFV-MANO entity - Conflict ... Test objective: The objective is to test that the modification of the NFV-MANO entity resource failed due to a conflict with the state of the NFV-MANO entity resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: NFV-MANO entity resource is already created. - ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The NFV-MANO entity is not modified by the operation @@ -88,7 +88,7 @@ PATCH NFV-MANO entity - PreCondition Failed ... Test title: PATCH NFV-MANO entity - PreCondition Failed ... Test objective: The objective is to test that the modification of the NFV-MANO entity resource failed because precondition given in an HTTP request header is not fulfilled and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: NFV-MANO entity resource is already created. - ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The NFV-MANO entity is not modified by the operation @@ -101,7 +101,7 @@ DELETE NFV-MANO entity - Method not implemented ... Test title: DELETE NFV-MANO entity - Method not implemented ... Test objective: The objective is to test that DELETE method is not allowed to delete an NFV-MANO Entity. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOServiceInterfaces.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOServiceInterfaces.robot index 938b1b0f4..028f92fb4 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOServiceInterfaces.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOServiceInterfaces.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST NFV-MANO Service Interfaces - Method not implemented ... Test title: POST NFV-MANO Service Interfaces - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET NFV-MANO Service Interfaces ... Test title: GET NFV-MANO Service Interfaces ... Test objective: The objective is to query status information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET NFV-MANO Service Interfaces - invalid attribute-based filter ... Test title: GET NFV-MANO Service Interfaces - invalid attribute-based filter ... Test objective: The objective is to test that the retrieval of NFV-MANO Service Interfaces fails when using invalid attribute-based filter, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -51,7 +51,7 @@ GET NFV-MANO Service Interfaces - invalid attribute selector ... Test title: GET NFV-MANO Service Interfaces - invalid attribute selector ... Test objective: The objective is to test that the retrieval of NFV-MANO Service Interfaces fails when using invalid attribute selector, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -64,7 +64,7 @@ GET NFV-MANO Service Interfaces - Bad Request Response too Big ... Test title: GET NFV-MANO Service Interfaces - Bad Request Response too Big ... Test objective: The objective is to test that the retrieval of NFV-MANO Service Interfaces fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -77,7 +77,7 @@ GET NFV-MANO Service Interfaces with attribute-based filter ... Test title: GET NFV-MANO Service Interfaces with attribute-based filter ... Test objective: The objective is to query status information about multiple NFV-MANO service interfaces of the NFV-MANO functional entities with attribute filters, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -90,7 +90,7 @@ GET NFV-MANO Service Interfaces with "all_fields" attribute selector ... Test title: GET NFV-MANO Service Interface with "all_fields" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with "all_fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -103,7 +103,7 @@ GET NFV-MANO Service Interfaces with "exclude_default" attribute selector ... Test title: GET NFV-MANO Service Interfaces with "exclude_default" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with "exclude_default" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -116,7 +116,7 @@ GET NFV-MANO Service Interfaces with "fields" attribute selector ... Test title: GET NFV-MANO Service Interfaces with "fields" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with fields attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -129,7 +129,7 @@ GET NFV-MANO Service Interfaces with "exclude_fields" attribute selector ... Test title: GET NFV-MANO Service Interfaces with "exclude_fields" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with "exclude_fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -142,7 +142,7 @@ GET NFV-MANO Service Interfaces with "exclude_default" and "fields" attribute se ... Test title: GET NFV-MANO Service Interfaces with "exclude_default" and "fields" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with "exclude_default" and "fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -155,7 +155,7 @@ GET NFV-MANO Service Interfaces with Paged Response ... Test title: GET NFV-MANO Service Interfaces with Paged Response ... Test objective: The objective is to query NFV-MANO Service Interface to get Paged Response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -168,7 +168,7 @@ PUT NFV-MANO Service Interfaces - Method not implemented ... Test title: PUT NFV-MANO Service Interfaces - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -180,7 +180,7 @@ PATCH NFV-MANO Service Interfaces - Method not implemented ... Test title: PATCH NFV-MANO Service Interfaces - Method not implemented ... Test objective: The objective is to test that PATCH method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -192,7 +192,7 @@ DELETE NFV-MANO Service Interfaces - Method not implemented ... Test title: DELETE NFV-MANO Service Interfaces - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NotificationEndpoint.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NotificationEndpoint.robot index 7ffefd8e7..23b3e92f6 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NotificationEndpoint.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NotificationEndpoint.robot @@ -13,7 +13,7 @@ Information Changed Notification ... Test title: Information Changed Notification ... Test objective: The objective is to test that Information Changed Notification is delivered with success to the notification consumer ... Pre-conditions: A subscription for information availability notification is available in the NFV-MANO. - ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_Notif_Endpoint ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ Change State Notification ... Test title: Change State Notification ... Test objective: The objective is to test that Change State Notification is delivered with success to the notification consumer ... Pre-conditions: A subscription for change state notification is available in the NFV-MANO. - ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_Notif_Endpoint ... Applicability: none ... Post-Conditions: none @@ -56,7 +56,7 @@ Post Information Changed Notification ${body}= Format String ${template} subscriptionId=${subscriptionId} Post ${callbackResp} ${body} ${outputResponse}= Output response - Set Global Variable ${response} ${outputResponse} + Set Global Variable ${response} ${outputResponse} Post Change State Notification log Trying to perform a POST to get notification @@ -67,4 +67,4 @@ Post Change State Notification ${body}= Format String ${template} subscriptionId=${subscriptionId} changeStateOpOccId=${changeStateOpOccId} Post ${callbackResp} ${body} ${outputResponse}= Output response - Set Global Variable ${response} ${outputResponse} + Set Global Variable ${response} ${outputResponse} diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Notifications.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Notifications.robot index 7e00c3d89..3e936b98e 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Notifications.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Notifications.robot @@ -1,5 +1,5 @@ *** Setting *** -Resource environment/variables.txt +Resource environment/variables.txt Suite Setup Create Sessions Suite Teardown Terminate All Processes kill=true Library MockServerLibrary @@ -16,7 +16,7 @@ Information Changed Notification ... Test title: Information Changed Notification ... Test objective: The objective is to test the dispatch of Information Changed Notification when configuration or information is changed in the NFV-MANO, and perform a JSON schema and content validation of the delivered notification. The action that triggers the notification under test is an explicit test step, but it is not performed by the test system. ... Pre-conditions: A subscription for information availability notifications is available in the NFV-MANO. - ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -29,7 +29,7 @@ Change State Notification ... Test title: Change State Notification ... Test objective: The objective is to test the dispatch of Change State Notification when state changes of the NFV-MANO functional entity and its managed objects, and perform a JSON schema and content validation of the delivered notification. The action that triggers the notification under test is an explicit test step, but it is not performed by the test system. ... Pre-conditions: A performance job is created, and a state change subscription is available in the NFV-MANO. - ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANOz ... Applicability: none ... Post-Conditions: none @@ -49,7 +49,7 @@ Trigger the cross of Change State (external action) Check Information Changed Notification Available Http POST Request Body Json Schema Is [Arguments] ${element} - ${schema}= Get File schemas/${element}.schema.json + ${schema}= Get File schemas/${element}.schema.json Configure Notification Forward ${schema} ${callback_endpoint} ${callback_endpoint_fwd} Check Information Changed Notification Available Http POST Request Body notificationType attribute Is @@ -61,7 +61,7 @@ Check Information Changed Notification Available Http POST Request Body notifica Check Change State Notification Http POST Request Body Json Schema Is [Arguments] ${element} - ${schema}= Get File schemas/${element}.schema.json + ${schema}= Get File schemas/${element}.schema.json Configure Notification Forward ${schema} ${callback_endpoint} ${callback_endpoint_fwd} @@ -85,7 +85,7 @@ Configure Notification Information Changed Notification Available Handler set to dictionary ${json} notificationType ${type} ${BODY}= evaluate json.dumps(${json}) json Log Creating mock request and response to handle status notification - &{req}= Create Mock Request Matcher POST ${endpoint} body_type="JSON" body=${BODY} + &{req}= Create Mock Request Matcher POST ${endpoint} body_type="JSON" body=${BODY} Set Global Variable ${notification_request} ${req} &{notification_response}= Create Mock Response status_code=204 Create Mock Expectation ${notification_request} ${notification_response} @@ -96,7 +96,7 @@ Configure Notification State Crossed Handler set to dictionary ${json} notificationType ${type} ${BODY}= evaluate json.dumps(${json}) json Log Creating mock request and response to handle status notification - &{req}= Create Mock Request Matcher POST ${endpoint} body_type="JSON" body=${BODY} + &{req}= Create Mock Request Matcher POST ${endpoint} body_type="JSON" body=${BODY} Set Global Variable ${notification_request} ${req} &{notification_response}= Create Mock Response status_code=204 Create Mock Expectation ${notification_request} ${notification_response} @@ -104,8 +104,8 @@ Configure Notification State Crossed Handler Configure Notification Forward [Arguments] ${schema} ${endpoint} ${endpoint_fwd} Log Creating mock Http POST forward to handle ${schema} - &{notification_tmp}= Create Mock Request Matcher POST ${endpoint} body_type="JSON_SCHEMA" body=${schema} - &{notification_fwd}= Create Mock Http Forward ${endpoint_fwd} + &{notification_tmp}= Create Mock Request Matcher POST ${endpoint} body_type="JSON_SCHEMA" body=${schema} + &{notification_fwd}= Create Mock Http Forward ${endpoint_fwd} Create Mock Expectation With Http Forward ${notification_tmp} ${notification_fwd} Create Sessions diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/PeerEntities.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/PeerEntities.robot index 2fe8eb548..dfbe06ecf 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/PeerEntities.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/PeerEntities.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Peer Entity ... Test title: POST Peer Entity ... Test objective: The objective is to creates in the producer NFV-MANO functional entity a new peer entity resource which contains configuration and information with regards to the peer functional entity and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: Peer Entity is created @@ -28,7 +28,7 @@ GET Peer Entities ... Test title: GET Peer Entities ... Test objective: The objective is to query information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -41,7 +41,7 @@ GET Peer Entities - invalid attribute-based filter ... Test title: GET Peer Entities - invalid attribute-based filter ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when using invalid attribute-based filter, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -54,7 +54,7 @@ GET Peer Entities - invalid attribute selector ... Test title: GET Peer Entities - invalid attribute selector ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when using invalid attribute selector, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -67,7 +67,7 @@ GET Peer Entities - Bad Request Response too Big ... Test title: GET Peer Entities - Bad Request Response too Big ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -80,7 +80,7 @@ GET Peer Entities with attribute-based filter ... Test title: GET Peer Entities with attribute-based filter ... Test objective: The objective is to query information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with attribute filters, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -93,7 +93,7 @@ GET Peer Entities with "all_fields" attribute selector ... Test title: GET Peer Entities with "all_fields" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with "all_fields" attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -106,7 +106,7 @@ GET Peer Entities with "exclude_default" attribute selector ... Test title: GET Peer Entities with "exclude_default" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with "exclude_default" attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -119,7 +119,7 @@ GET Peer Entities with "fields" attribute selector ... Test title: GET Peer Entities with "fields" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with fields attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -132,7 +132,7 @@ GET Peer Entities with "exclude_fields" attribute selector ... Test title: GET Peer Entities with "exclude_fields" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with "exclude_fields" attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -145,7 +145,7 @@ GET Peer Entities with "exclude_default" and "fields" attribute selector ... Test title: GET Peer Entities with "exclude_default" and "fields" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with "exclude_default" and "fields" attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -158,7 +158,7 @@ GET Peer Entity with Paged Response ... Test title: GET Peer Entity with Paged Response ... Test objective: The objective is to query information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities to get Paged Response. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -171,7 +171,7 @@ Get Peer Entity with malformed authorization token ... Test title: Get Peer Entity with malformed authorization token ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when using malformed authorization token. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The Peer Entity requires the usage of access tokens for authorizing the API requests. ... Post-Conditions: none @@ -183,7 +183,7 @@ Get Peer Entity without authorization token ... Test title: Get Peer Entity without authorization token ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when omitting the authorization token. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The Peer Entity requires the usage of access tokens for authorizing the API requests. ... Post-Conditions: none @@ -195,7 +195,7 @@ GET information about multiple alarms with expired or revoked authorization toke ... Test title: GET information about multiple alarms with expired or revoked authorization token ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when using expired or revoked authorization token. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The Peer Entity requires the usage of access tokens for authorizing the API requests. ... Post-Conditions: none @@ -207,7 +207,7 @@ PUT Peer Entities - Method not implemented ... Test title: PUT Peer Entities - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -219,7 +219,7 @@ PATCH Peer Entities - Method not implemented ... Test title: PATCH Peer Entities - Method not implemented ... Test objective: The objective is to test that PATCH method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -231,7 +231,7 @@ DELETE Peer Entities - Method not implemented ... Test title: DELETE Peer Entities - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 9ff981dd1..5d4d1f303 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -16,7 +16,7 @@ GET all Subscriptions ... Test title: GET all Subscriptions ... Test objective: The objective is to test the retrieval list of active subscriptions of API consumer and perform a JSON schema validation of the returned subscriptions data structure. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -29,7 +29,7 @@ GET Subscriptions with attribute-based filter ... Test title: GET Subscriptions with attribute-based filter ... Test objective: The objective is to test the retrieval of active subscriptions list of API consumer using attribute-based filter and perform a JSON schema validation of the collected indicators data structure. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -42,7 +42,7 @@ GET Subscriptions with Paged Response ... Test title: GET Subscriptions with Paged Response ... Test objective: The objective is to query information of active subscriptions list to of API consumer to get Paged Response. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: ... Post-Conditions: @@ -55,7 +55,7 @@ GET Subscriptions - invalid attribute-based filter ... Test title: GET Subscriptions - invalid attribute-based filter ... Test objective: The objective is to test that the retrieval of active subscriptions list of API consumer fails when using invalid attribute-based filters, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -69,7 +69,7 @@ GET Subscriptions - Bad Request Response too Big ... Test title: GET Subscriptions - Bad Request Response too Big ... Test objective: The objective is to test that the retrieval of active subscriptions list of API consumer fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -82,7 +82,7 @@ GET Subscriptions - invalid resource endpoint ... Test title: GET Subscriptions - invalid resource endpoint ... Test objective: The objective is to test that the retrieval of active subscriptions list of API consumer fails when using invalid resource endpoint. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -94,7 +94,7 @@ Create new Subscription ... Test title: Create new Subscription ... Test objective: The objective is to test the creation of a new subscription and perform a JSON schema and content validation of the returned subscription data structure ... Pre-conditions: none - ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The subscription is successfully set and it matches the issued subscription @@ -111,7 +111,7 @@ Create request for duplicated Subscription not creating duplicated subscriptions ... Test title: Create request for duplicated Subscription not creating duplicated subscriptions ... Test objective: The objective is to test the attempt of a creation of a duplicated subscription failed and check that no new subscription is created and a link to the original subscription is returned ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The NFV-MANO does not support the creation of duplicated subscriptions ... Post-Conditions: The existing Subscription returned is available in the NFV-MANO @@ -127,7 +127,7 @@ Create request for duplicated Subscription creating duplicated subscriptions ... Test title: Create request for duplicated Subscription creating duplicated subscriptions ... Test objective: The objective is to test the creation of a duplicated subscription and perform a JSON schema and content validation of the returned duplicated subscription data structure ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The NFV-MANO supports the creation of duplicated subscriptions ... Post-Conditions: The duplicated subscription is successfully set and it matches the issued subscription @@ -142,7 +142,7 @@ PUT Subscriptions - Method not implemented ... Test title: PUT Subscriptions - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to modify subscriptions ... Pre-conditions: none - ... Reference: clause 5.5.4.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -154,7 +154,7 @@ PATCH Subscriptions - Method not implemented ... Test title: PATCH Subscriptions - Method not implemented ... Test objective: The objective is to test that PATCH method is not allowed to update subscriptions ... Pre-conditions: none - ... Reference: clause 5.5.4.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -166,7 +166,7 @@ DELETE Subscriptions - Method not implemented ... Test title: DELETE Subscriptions - Method not implemented ... Test objective: The objective is to test that DELETE method is not allowed to delete subscriptions ... Pre-conditions: none - ... Reference: clause 5.5.4.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none -- GitLab From 221c5f78a58efdae7bd07e3c5c6bad692203e9b2 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 15:00:45 +0500 Subject: [PATCH 03/22] add POST unprocessable entity test case for subscriptions --- .../Subscriptions.robot | 19 ++++++++++-- .../schemas/ProblemDetails.schema.json | 30 ++++++++++++++++++- 2 files changed, 45 insertions(+), 4 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 5d4d1f303..ada4ec7a4 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -89,7 +89,7 @@ GET Subscriptions - invalid resource endpoint Get all Subscriptions Check HTTP Response Status Code Is 404 -Create new Subscription +POST Create new Subscription [Documentation] Test ID: 8.3.1.10.7 ... Test title: Create new Subscription ... Test objective: The objective is to test the creation of a new subscription and perform a JSON schema and content validation of the returned subscription data structure @@ -105,7 +105,7 @@ Create new Subscription Check Postcondition Subscription Is Set -Create request for duplicated Subscription not creating duplicated subscriptions +POST Create request for duplicated Subscription not creating duplicated subscriptions [Tags] no-duplicated-subs [Documentation] Test ID: 8.3.1.10.8 ... Test title: Create request for duplicated Subscription not creating duplicated subscriptions @@ -121,7 +121,7 @@ Create request for duplicated Subscription not creating duplicated subscriptions Check HTTP Response Header Contains Location Check Postcondition Subscription Resource Returned in Location Header Is Available -Create request for duplicated Subscription creating duplicated subscriptions +POST Create request for duplicated Subscription creating duplicated subscriptions [Tags] duplicated-subs [Documentation] Test ID: 8.3.1.10.9 ... Test title: Create request for duplicated Subscription creating duplicated subscriptions @@ -172,3 +172,16 @@ DELETE Subscriptions - Method not implemented ... Post-Conditions: none Send Delete Request for Subscriptions Check HTTP Response Status Code Is 405 + +POST Create a new subscription - Unprocessable Entity + [Documentation] Test ID: 8.3.1.10.13 + ... Test title: POST Create a new Subscription - Unprocessable Entity + ... Test objective: The objective is to test that content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. + ... Pre-conditions: none + ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 + ... Config ID: Config_prod_NFV-MANO + ... Applicability: none + ... Post-Conditions: none + Send Post Request for Subscription + Check HTTP Response Status Code Is 422 + Check HTTP Response Body Json Schema Is ProblemDetails diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ProblemDetails.schema.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ProblemDetails.schema.json index 2af3ef9b3..bd236d731 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ProblemDetails.schema.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ProblemDetails.schema.json @@ -1 +1,29 @@ -{ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n", "type": "object", "required": [ "status", "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\".\n", "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).\n", "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.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string", "format": "URI" } }} \ No newline at end of file +{ + "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n", + "type": "object", + "required": ["status", "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\".\n", + "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).\n", + "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.\n", + "type": "integer" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.\n", + "type": "string" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type": "string", + "format": "URI" + } + } +} -- GitLab From 06f56d13644355786d372dbcd4729953b7769f37 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 15:39:39 +0500 Subject: [PATCH 04/22] update apiMajorVersion in variables.txt --- .../environment/variables.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt index 35efe08ef..b9aec98f2 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt @@ -18,7 +18,7 @@ ${NFVMANO_CHECKS_NOTIF_ENDPOINT} 1 ## If true, during subscription, th ${NFVMANO_ALLOWS_DUPLICATE_SUBS} 1 ${apiRoot} / -${apiMajorVersion} v1 +${apiMajorVersion} v2 ${apiName} nfvmanocim ${response} -- GitLab From e09307cae49fb0a5b06088484fadf04c086aac56 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 17:04:45 +0500 Subject: [PATCH 05/22] fix POST subscriptions - unprocessable entity test case --- .../NFVMANOCimKeywords.robot | 12 ++++++++++++ .../Subscriptions.robot | 4 ++-- .../environment/variables.txt | 1 + 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot index 44fb39106..cb1eb6210 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot @@ -675,6 +675,18 @@ Send Post Request for Subscription Run Keyword If ${NFVMANO_CHECKS_NOTIF_ENDPOINT} == 1 ... Check Notification Endpoint +Send Post Request for Subscription with Unreachable callbackUri + Set headers {"Content-Type": "${CONTENT_TYPE_JSON}"} + Set headers {"Accept": "${ACCEPT_JSON}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": ${AUTHORIZATION}"} + ${template}= Get File jsons/CimSubscriptionRequest.json + ${body_request}= Format String ${template} callback_uri=${unreachable_callback_uri} callback_endpoint=${callback_endpoint} + POST ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${body_request} + ${output}= Output response + Set Suite Variable ${response} ${output} + Run Keyword If ${NFVMANO_CHECKS_NOTIF_ENDPOINT} == 1 + ... Check Notification Endpoint + Check HTTP Response Body CimSubscription Attributes Values Match the Issued Subscription Log Check Response matches subscription ${template}= Get File jsons/CimSubscriptionRequest.json diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index ada4ec7a4..4cb9a4901 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -176,12 +176,12 @@ DELETE Subscriptions - Method not implemented POST Create a new subscription - Unprocessable Entity [Documentation] Test ID: 8.3.1.10.13 ... Test title: POST Create a new Subscription - Unprocessable Entity - ... Test objective: The objective is to test that content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. + ... Test objective: The objective is to test that for a POST request for a new subscription, if the test by NFV-MANO for notification endpoint fails, then error 422 will be returned. ... Pre-conditions: none ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none - Send Post Request for Subscription + Send Post Request for Subscription with Unreachable callbackUri Check HTTP Response Status Code Is 422 Check HTTP Response Body Json Schema Is ProblemDetails diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt index b9aec98f2..b86b897ab 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt @@ -36,6 +36,7 @@ ${peerEntityId} ${callback_port} 9091 ${callback_uri} http://172.22.1.7:${callback_port} +${unreachable_callback_uri} http://unreachable_callback_uri-error-code-422 ${callback_endpoint} /subscriptions ${filter_ok} callbackUri=${callbackUri} ${filter_ko} erroneousFilter=erroneous -- GitLab From 55c380541e85e4f05fc960a3c3441bf77928b187 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 17:09:52 +0500 Subject: [PATCH 06/22] rename schema files --- ...on => ChangeStateNotification.schema.json} | 300 +++--- ...pOcc.json => ChangeStateOpOcc.schema.json} | 168 ++-- ...ccs.json => ChangeStateOpOccs.schema.json} | 174 ++-- ...ption.json => CimSubscription.schema.json} | 224 ++--- ...ions.json => CimSubscriptions.schema.json} | 230 ++--- ...nformationChangedNotification.schema.json} | 160 ++-- ...on => ManoConfigModifications.schema.json} | 170 ++-- ...ManoEntity.json => ManoEntity.schema.json} | 866 +++++++++--------- ....json => ManoServiceInterface.schema.json} | 428 ++++----- ...ServiceInterfaceModifications.schema.json} | 208 ++--- ...json => ManoServiceInterfaces.schema.json} | 434 ++++----- ...Entities.json => PeerEntities.schema.json} | 422 ++++----- ...PeerEntity.json => PeerEntity.schema.json} | 416 ++++----- 13 files changed, 2100 insertions(+), 2100 deletions(-) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ChangeStateNotification.json => ChangeStateNotification.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ChangeStateOpOcc.json => ChangeStateOpOcc.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ChangeStateOpOccs.json => ChangeStateOpOccs.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{CimSubscription.json => CimSubscription.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{CimSubscriptions.json => CimSubscriptions.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{InformationChangedNotification.json => InformationChangedNotification.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoConfigModifications.json => ManoConfigModifications.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoEntity.json => ManoEntity.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoServiceInterface.json => ManoServiceInterface.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoServiceInterfaceModifications.json => ManoServiceInterfaceModifications.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoServiceInterfaces.json => ManoServiceInterfaces.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{PeerEntities.json => PeerEntities.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{PeerEntity.json => PeerEntity.schema.json} (98%) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.schema.json index 960b9e7d0..1d887a364 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.schema.json @@ -1,151 +1,151 @@ -{ - "description": "This type represents a Change state operation occurrence.\n", - "type": "object", - "required": [ - "id", - "notificationType", - "subscriptionId", - "timestamp", - "changeStateOpOccId", - "stateChangedTime", - "changeStateOperationState", - "managedObjectRef", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "notificationType": { - "description": "Discriminator for the different notification types. Shall be set to \"ChangeStateNotification\" for this notification type.\n", - "type": "string" - }, - "subscriptionId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "timestamp": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "changeStateOpOccId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "stateChangedTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "changeStateOperationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "required": [ - "type", - "objectId" - ] - }, - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "_links": { - "description": "Links to resources related to this notification.\n", - "type": "object", - "properties": { - "subscription": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "objectInstance": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "changeStateOpOcc": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - }, - "required": [ - "subscription", - "objectInstance", - "changeStateOpOcc" - ] - } - } +{ + "description": "This type represents a Change state operation occurrence.\n", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timestamp", + "changeStateOpOccId", + "stateChangedTime", + "changeStateOperationState", + "managedObjectRef", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationType": { + "description": "Discriminator for the different notification types. Shall be set to \"ChangeStateNotification\" for this notification type.\n", + "type": "string" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timestamp": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "changeStateOpOccId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "stateChangedTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "changeStateOperationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] + }, + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "required": [ + "type", + "objectId" + ] + }, + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "_links": { + "description": "Links to resources related to this notification.\n", + "type": "object", + "properties": { + "subscription": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "objectInstance": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "changeStateOpOcc": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "subscription", + "objectInstance", + "changeStateOpOcc" + ] + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.schema.json index b0c3c9178..53e9d8228 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.schema.json @@ -1,85 +1,85 @@ -{ - "description": "This type represents a Change state operation occurrence. \n", - "type": "object", - "required": [ - "id", - "operationState", - "stateEnteredTime", - "startTime", - "managedObjectRef" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "operationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "stateEnteredTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "required": [ - "type", - "objectId" - ] - }, - "changeOperationalStateRequest": { - "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", - "type": "string", - "enum": [ - "START", - "STOP", - "RESTART" - ] - }, - "changeAdministrativeStateRequest": { - "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", - "type": "string", - "enum": [ - "LOCK", - "UNLOCK" - ] - }, - "operationParams": { - "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" - } - } +{ + "description": "This type represents a Change state operation occurrence. \n", + "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "managedObjectRef" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "stateEnteredTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] + }, + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "required": [ + "type", + "objectId" + ] + }, + "changeOperationalStateRequest": { + "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", + "type": "string", + "enum": [ + "START", + "STOP", + "RESTART" + ] + }, + "changeAdministrativeStateRequest": { + "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", + "type": "string", + "enum": [ + "LOCK", + "UNLOCK" + ] + }, + "operationParams": { + "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.schema.json index 9f57c2454..2c222b3b5 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.schema.json @@ -1,88 +1,88 @@ -{ - "type": "array", - "items": { - "description": "This type represents a Change state operation occurrence. \n", - "type": "object", - "required": [ - "id", - "operationState", - "stateEnteredTime", - "startTime", - "managedObjectRef" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "operationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "stateEnteredTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "required": [ - "type", - "objectId" - ] - }, - "changeOperationalStateRequest": { - "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", - "type": "string", - "enum": [ - "START", - "STOP", - "RESTART" - ] - }, - "changeAdministrativeStateRequest": { - "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", - "type": "string", - "enum": [ - "LOCK", - "UNLOCK" - ] - }, - "operationParams": { - "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" - } - } - } +{ + "type": "array", + "items": { + "description": "This type represents a Change state operation occurrence. \n", + "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "managedObjectRef" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "stateEnteredTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] + }, + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "required": [ + "type", + "objectId" + ] + }, + "changeOperationalStateRequest": { + "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", + "type": "string", + "enum": [ + "START", + "STOP", + "RESTART" + ] + }, + "changeAdministrativeStateRequest": { + "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", + "type": "string", + "enum": [ + "LOCK", + "UNLOCK" + ] + }, + "operationParams": { + "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.schema.json index 1a7e924ed..ced25bc5f 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.schema.json @@ -1,113 +1,113 @@ -{ - "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", - "type": "object", - "required": [ - "id", - "callbackUri", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "filter": { - "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", - "type": "object", - "properties": { - "manoEntitySubscriptionFilter": { - "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", - "type": "object", - "properties": { - "manoEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "manoServiceIds": { - "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceNames": { - "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "manoServiceInterfaceIds": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceInterfaceNames": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "consumedManoInterfaceIds": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - } - }, - "consumedManoInterfaceNames": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "notificationTypes": { - "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "InformationChangedNotification", - "ChangeStateNotification" - ] - } - } - } - }, - "callbackUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - }, - "required": [ - "self" - ] - } - } +{ + "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", + "type": "object", + "required": [ + "id", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "filter": { + "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", + "type": "object", + "properties": { + "manoEntitySubscriptionFilter": { + "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", + "type": "object", + "properties": { + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "manoServiceIds": { + "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceNames": { + "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "manoServiceInterfaceIds": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceInterfaceNames": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "consumedManoInterfaceIds": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + } + }, + "consumedManoInterfaceNames": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "notificationTypes": { + "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "InformationChangedNotification", + "ChangeStateNotification" + ] + } + } + } + }, + "callbackUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.schema.json index a7578f88d..2098ec69c 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.schema.json @@ -1,116 +1,116 @@ -{ - "type": "array", - "items": { - "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", - "type": "object", - "required": [ - "id", - "callbackUri", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "filter": { - "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", - "type": "object", - "properties": { - "manoEntitySubscriptionFilter": { - "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", - "type": "object", - "properties": { - "manoEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "manoServiceIds": { - "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceNames": { - "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "manoServiceInterfaceIds": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceInterfaceNames": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "consumedManoInterfaceIds": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - } - }, - "consumedManoInterfaceNames": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "notificationTypes": { - "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "InformationChangedNotification", - "ChangeStateNotification" - ] - } - } - } - }, - "callbackUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - }, - "required": [ - "self" - ] - } - } - } +{ + "type": "array", + "items": { + "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", + "type": "object", + "required": [ + "id", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "filter": { + "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", + "type": "object", + "properties": { + "manoEntitySubscriptionFilter": { + "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", + "type": "object", + "properties": { + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "manoServiceIds": { + "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceNames": { + "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "manoServiceInterfaceIds": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceInterfaceNames": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "consumedManoInterfaceIds": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + } + }, + "consumedManoInterfaceNames": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "notificationTypes": { + "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "InformationChangedNotification", + "ChangeStateNotification" + ] + } + } + } + }, + "callbackUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.schema.json index 696f45239..b906a3a5a 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.schema.json @@ -1,81 +1,81 @@ -{ - "description": "This type represents a notification that is sent when data about configuration and information of the NFV-MANO functional entity have been changed.\n", - "type": "object", - "required": [ - "id", - "notificationType", - "subscriptionId", - "timeStamp", - "informationChangedTime", - "manoEntityId", - "changedInfo", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "notificationType": { - "description": "Discriminator for the different notification types. Shall be set to \"InformationChangedNotification\" for this notification type.\n", - "type": "string" - }, - "subscriptionId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "timeStamp": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "informationChangedTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "manoEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "changedInfo": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - }, - "_links": { - "description": "Links to resources related to this notification.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "subscription": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - }, - "required": [ - "self" - ] - } - } +{ + "description": "This type represents a notification that is sent when data about configuration and information of the NFV-MANO functional entity have been changed.\n", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timeStamp", + "informationChangedTime", + "manoEntityId", + "changedInfo", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationType": { + "description": "Discriminator for the different notification types. Shall be set to \"InformationChangedNotification\" for this notification type.\n", + "type": "string" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timeStamp": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "informationChangedTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "changedInfo": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + }, + "_links": { + "description": "Links to resources related to this notification.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "subscription": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.schema.json index ea15fde7d..9ecde8ddb 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.schema.json @@ -1,86 +1,86 @@ -{ - "description": "This type represents attribute modifications that were performed on the \"NFV-MANO entity\" resource of the producer NFV-MANO functional entity. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoConfigModificationRequest\" data structure. \n", - "type": "object", - "properties": { - "name": { - "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3\n", - "type": "string" - }, - "description": { - "description": "If present, this attribute signals modifications of the \"description\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3.\n", - "type": "string" - }, - "clockSyncs": { - "description": "If present, this attribute signals modifications of the \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", - "type": "object", - "additionalProperties": { - "description": "This type represents parameters for connecting to an NTP server. * NOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "description": "Type of clock synchronization.\nPermitted values:\n - NTP: For Network Time Protocol (NTP) based clock synchronization.\n - OTHER: For other types of clock synchronization.\n", - "type": "string", - "enum": [ - "NTP", - "OTHER" - ] - }, - "ntpServerInfo": { - "description": "Information for the NTP based clock synchronization. Shall be present if type = \"NTP\".\n", - "type": "object", - "properties": { - "ipAddress": { - "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", - "type": "string", - "format": "IP" - }, - "hostname": { - "description": "Indicates the hostname of the NTP server. See note.\n", - "type": "string" - } - } - }, - "otherClockSyncParams": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } - } - }, - "defaultLogCompileBySizeValue": { - "description": "Unsigned integer\n", - "type": "number" - }, - "defaultLogCompileByTimerValue": { - "description": "Unsigned integer\n", - "type": "number" - }, - "manoServiceModifications": { - "description": "If present, this attribute signals modifications of the \"manoServices\" attribute array in the \"ManoEntity\", as defined in clause 5.6.2.3.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "If present, this attribute signals modification of the \"name\" attribute in the \"ManoService\".\n", - "type": "string" - }, - "description": { - "description": "If present, this attribute signals modification of the \"description\" attribute in the \"ManoService\".\n", - "type": "string" - } - }, - "required": [ - "id" - ] - } - } - } +{ + "description": "This type represents attribute modifications that were performed on the \"NFV-MANO entity\" resource of the producer NFV-MANO functional entity. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoConfigModificationRequest\" data structure. \n", + "type": "object", + "properties": { + "name": { + "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3\n", + "type": "string" + }, + "description": { + "description": "If present, this attribute signals modifications of the \"description\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3.\n", + "type": "string" + }, + "clockSyncs": { + "description": "If present, this attribute signals modifications of the \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents parameters for connecting to an NTP server. * NOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Type of clock synchronization.\nPermitted values:\n - NTP: For Network Time Protocol (NTP) based clock synchronization.\n - OTHER: For other types of clock synchronization.\n", + "type": "string", + "enum": [ + "NTP", + "OTHER" + ] + }, + "ntpServerInfo": { + "description": "Information for the NTP based clock synchronization. Shall be present if type = \"NTP\".\n", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type": "string", + "format": "IP" + }, + "hostname": { + "description": "Indicates the hostname of the NTP server. See note.\n", + "type": "string" + } + } + }, + "otherClockSyncParams": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } + } + }, + "defaultLogCompileBySizeValue": { + "description": "Unsigned integer\n", + "type": "number" + }, + "defaultLogCompileByTimerValue": { + "description": "Unsigned integer\n", + "type": "number" + }, + "manoServiceModifications": { + "description": "If present, this attribute signals modifications of the \"manoServices\" attribute array in the \"ManoEntity\", as defined in clause 5.6.2.3.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "If present, this attribute signals modification of the \"name\" attribute in the \"ManoService\".\n", + "type": "string" + }, + "description": { + "description": "If present, this attribute signals modification of the \"description\" attribute in the \"ManoService\".\n", + "type": "string" + } + }, + "required": [ + "id" + ] + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.schema.json index b78f2a698..29484d403 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.schema.json @@ -1,434 +1,434 @@ -{ - "description": "This type represents an NFV-MANO functional entity. * NOTE 1:\tIt shall be present when \"type\" attribute is \"NFVO\", and it shall be absent in any other case. * NOTE 2:\tIt shall be present when \"type\" attribute is \"VNFM\", and it shall be absent in any other case. * NOTE 3:\tIt shall be present when \"type\" attribute is \"VIM\", and it shall be absent in any other case. * NOTE 4:\tThe information about the NFV-MANO services offered by a specific type of NFV-MANO functional\n entity is specified by the manoServices attribute.\n* NOTE 5:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute. * NOTE 6:\tIt shall be present when \"type\" attribute is \"WIM\", and it shall be absent in any other case.\n", - "type": "object", - "required": [ - "id", - "type", - "name", - "description", - "provider", - "softwareVersion", - "manoConfigurableParams", - "manoApplicationState", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "type": { - "description": "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\t The NFV-MANO functional entity is a VIM.\n - WIM The NFV-MANO functional entity is a WIM.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM", - "WIM" - ] - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "description": { - "description": "Human-readable description of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "provider": { - "description": "Information about the provider of the NFV-MANO functional entity. It typically includes the name of the provider.\n", - "type": "string" - }, - "softwareVersion": { - "description": "A version.\n", - "type": "string" - }, - "manoEntityComponents": { - "description": "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. See note 5.\n", - "type": "array", - "items": { - "description": "This type represents information of a deployed component realizing part of an NFV-MANO functional entity. It is optional for the API producer to support this type. \n", - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "manoServiceIds": { - "description": "References to the NFV-MANO services that depend on the NFV-MANO functional entity component. The identifier of the ManoService is referred. A service may depend on multiple components. Multiple services may depend on the same component.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - } - } - } - }, - "manoServices": { - "description": "Information about the NFV-MANO services provided by the NFV-MANO functional entity.\n", - "type": "array", - "items": { - "description": "This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity. * NOTE:\tA cardinality greater than one supports having different interface versions or api Endpoints\n to be used for accessing the same instance of an NFV-MANO service.\n", - "type": "object", - "required": [ - "id", - "name", - "description", - "manoServiceInterfaceIds", - "_links" - ], - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "description": { - "description": "Human-readable description of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "manoServiceInterfaceIds": { - "description": "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. See note\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "minItems": 1 - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "manoServiceInterfaces": { - "description": "Link to the \"individual NFV-MANO service interface\" resources with information about the associated interfaces to the NFV-MANO service.\n", - "type": "array", - "items": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "minItems": 1 - } - }, - "required": [ - "manoServiceInterfaces" - ] - } - } - } - }, - "manoConfigurableParams": { - "description": "# Warning: No definition found in the document ManoConfigurableParams\n" - }, - "manoApplicationState": { - "description": "Information and current values of the NFV-MANO functional entityΓÇÖs application state. \n", - "type": "object", - "required": [ - "operationalState", - "administrativeState", - "usageState" - ], - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } - } - }, - "nfvoSpecificInfo": { - "description": "This type represents information attributes specific to an NFVO entity, and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined.\n", - "type": "object", - "required": [ - "supportedVnfdFormats", - "supportedNsdFormats" - ], - "properties": { - "maxOnboardedNsdNum": { - "description": "Maximum number of NSDs that can be on-boarded on the NFVO. See note 2.\n", - "type": "integer" - }, - "maxOnboardedVnfPkgNum": { - "description": "Maximum number of VNF Packages that can be on-boarded on the NFVO. See note 2.\n", - "type": "integer" - }, - "supportedVnfdFormats": { - "description": "Supported VNFD data formats.\n", - "type": "object", - "properties": { - "vnfdFormat": { - "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } - }, - "required": [ - "vnfdFormat", - "standardVersion" - ] - }, - "supportedNsdFormats": { - "description": "Supported NSD data formats.\n", - "type": "object", - "properties": { - "nsdFormat": { - "description": "Name of the NSD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } - }, - "required": [ - "nsdFormat", - "standardVersion" - ] - } - } - }, - "vnfmSpecificInfo": { - "description": "This type represents information attributes specific to a VNFM entity, and that can be relevant to more than one NFV-MANO service offered by a VNFM entity. * NOTE:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n", - "type": "object", - "required": [ - "resoruceMgmtModeSupport", - "managedVnfInstanceInfos", - "supportedVnfdFormats" - ], - "properties": { - "resoruceMgmtModeSupport": { - "description": "The supported resource management modes of the VNFM.\nPermitted values:\n - DIRECT: The VNFM supports direct mode only.\n - INDIRECT: The VNFM supports indirect mode only.\n - BOTH: The VNFM supports both direct and indirect mode.\n", - "type": "string", - "enum": [ - "DIRECT", - "INDIRECT", - "BOTH" - ] - }, - "managedVnfInstanceInfos": { - "description": "The kinds of VNF instances that can be managed, e.g. to determine the compatibility of a VNF with certain VNFM according to the vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - }, - "supportedVnfdFormats": { - "description": "Supported VNFD data formats.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "vnfdFormat": { - "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } - }, - "required": [ - "vnfdFormat", - "standardVersion" - ] - }, - "minItems": 1 - } - } - }, - "vimSpecificInfo": { - "description": "This type represents information attributes specific to a VIM entity, and that can be relevant to more than one NFV-MANO service offered by a VIM entity.\n", - "type": "object" - }, - "wimSpecificInfo": { - "description": "This type represents information attributes specific to a WIM entity, and that can be relevant to more than one NFV MANO service offered by a WIM entity.\n", - "type": "object", - "required": [ - "maxMscsNums", - "maxMsncNum", - "mscsLayerProtocolSupport" - ], - "properties": { - "maxMscsNums": { - "description": "Maximum number of MSCS that the WIM can manage.\n", - "type": "object", - "required": [ - "numMscs" - ], - "properties": { - "numMscs": { - "description": "Maximum number of MSCS.\n", - "type": "integer" - }, - "criteriaNumMscs": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } - }, - "maxMsncNum": { - "description": "Maximum number of MSNC that the WIM can manage\n", - "type": "object", - "required": [ - "numMsnc" - ], - "properties": { - "numMsnc": { - "description": "Maximum number of MSNC..\n", - "type": "integer" - }, - "criteriaNumMsnc": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } - }, - "mscsLayerProtocolSupport": { - "description": "List of protocols of particular layers used to realize an MSCS that are supported by the WIM.\nPermitted values:\n - EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432.\n - EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214.\n - VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified\n in IETF RFC 4761 and IETF RFC.\n - VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2\n Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074.\n - VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074.\n - BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364.\n", - "type": "string", - "enum": [ - "EVPN_BGP_MPLS", - "EVPN_VPWS", - "VPLS_BGP", - "VPLS_LDP_L2TP", - "VPWS_LDP_L2TP", - "BGP_IP_VPN" - ] - } - } - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "required": [ - "self", - "manoServiceInterfaces", - "peerEntities", - "changeState", - "changeStateOpOccs" - ], - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "manoServiceInterfaces": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "peerEntities": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "changeState": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "changeStateOpOccs": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - } - } - } +{ + "description": "This type represents an NFV-MANO functional entity. * NOTE 1:\tIt shall be present when \"type\" attribute is \"NFVO\", and it shall be absent in any other case. * NOTE 2:\tIt shall be present when \"type\" attribute is \"VNFM\", and it shall be absent in any other case. * NOTE 3:\tIt shall be present when \"type\" attribute is \"VIM\", and it shall be absent in any other case. * NOTE 4:\tThe information about the NFV-MANO services offered by a specific type of NFV-MANO functional\n entity is specified by the manoServices attribute.\n* NOTE 5:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute. * NOTE 6:\tIt shall be present when \"type\" attribute is \"WIM\", and it shall be absent in any other case.\n", + "type": "object", + "required": [ + "id", + "type", + "name", + "description", + "provider", + "softwareVersion", + "manoConfigurableParams", + "manoApplicationState", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "type": { + "description": "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\t The NFV-MANO functional entity is a VIM.\n - WIM The NFV-MANO functional entity is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM" + ] + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "provider": { + "description": "Information about the provider of the NFV-MANO functional entity. It typically includes the name of the provider.\n", + "type": "string" + }, + "softwareVersion": { + "description": "A version.\n", + "type": "string" + }, + "manoEntityComponents": { + "description": "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. See note 5.\n", + "type": "array", + "items": { + "description": "This type represents information of a deployed component realizing part of an NFV-MANO functional entity. It is optional for the API producer to support this type. \n", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "manoServiceIds": { + "description": "References to the NFV-MANO services that depend on the NFV-MANO functional entity component. The identifier of the ManoService is referred. A service may depend on multiple components. Multiple services may depend on the same component.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + } + } + } + }, + "manoServices": { + "description": "Information about the NFV-MANO services provided by the NFV-MANO functional entity.\n", + "type": "array", + "items": { + "description": "This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity. * NOTE:\tA cardinality greater than one supports having different interface versions or api Endpoints\n to be used for accessing the same instance of an NFV-MANO service.\n", + "type": "object", + "required": [ + "id", + "name", + "description", + "manoServiceInterfaceIds", + "_links" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "manoServiceInterfaceIds": { + "description": "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. See note\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "minItems": 1 + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "manoServiceInterfaces": { + "description": "Link to the \"individual NFV-MANO service interface\" resources with information about the associated interfaces to the NFV-MANO service.\n", + "type": "array", + "items": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "minItems": 1 + } + }, + "required": [ + "manoServiceInterfaces" + ] + } + } + } + }, + "manoConfigurableParams": { + "description": "# Warning: No definition found in the document ManoConfigurableParams\n" + }, + "manoApplicationState": { + "description": "Information and current values of the NFV-MANO functional entityΓÇÖs application state. \n", + "type": "object", + "required": [ + "operationalState", + "administrativeState", + "usageState" + ], + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + } + } + }, + "nfvoSpecificInfo": { + "description": "This type represents information attributes specific to an NFVO entity, and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined.\n", + "type": "object", + "required": [ + "supportedVnfdFormats", + "supportedNsdFormats" + ], + "properties": { + "maxOnboardedNsdNum": { + "description": "Maximum number of NSDs that can be on-boarded on the NFVO. See note 2.\n", + "type": "integer" + }, + "maxOnboardedVnfPkgNum": { + "description": "Maximum number of VNF Packages that can be on-boarded on the NFVO. See note 2.\n", + "type": "integer" + }, + "supportedVnfdFormats": { + "description": "Supported VNFD data formats.\n", + "type": "object", + "properties": { + "vnfdFormat": { + "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + } + }, + "required": [ + "vnfdFormat", + "standardVersion" + ] + }, + "supportedNsdFormats": { + "description": "Supported NSD data formats.\n", + "type": "object", + "properties": { + "nsdFormat": { + "description": "Name of the NSD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + } + }, + "required": [ + "nsdFormat", + "standardVersion" + ] + } + } + }, + "vnfmSpecificInfo": { + "description": "This type represents information attributes specific to a VNFM entity, and that can be relevant to more than one NFV-MANO service offered by a VNFM entity. * NOTE:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n", + "type": "object", + "required": [ + "resoruceMgmtModeSupport", + "managedVnfInstanceInfos", + "supportedVnfdFormats" + ], + "properties": { + "resoruceMgmtModeSupport": { + "description": "The supported resource management modes of the VNFM.\nPermitted values:\n - DIRECT: The VNFM supports direct mode only.\n - INDIRECT: The VNFM supports indirect mode only.\n - BOTH: The VNFM supports both direct and indirect mode.\n", + "type": "string", + "enum": [ + "DIRECT", + "INDIRECT", + "BOTH" + ] + }, + "managedVnfInstanceInfos": { + "description": "The kinds of VNF instances that can be managed, e.g. to determine the compatibility of a VNF with certain VNFM according to the vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + }, + "supportedVnfdFormats": { + "description": "Supported VNFD data formats.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "vnfdFormat": { + "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + } + }, + "required": [ + "vnfdFormat", + "standardVersion" + ] + }, + "minItems": 1 + } + } + }, + "vimSpecificInfo": { + "description": "This type represents information attributes specific to a VIM entity, and that can be relevant to more than one NFV-MANO service offered by a VIM entity.\n", + "type": "object" + }, + "wimSpecificInfo": { + "description": "This type represents information attributes specific to a WIM entity, and that can be relevant to more than one NFV MANO service offered by a WIM entity.\n", + "type": "object", + "required": [ + "maxMscsNums", + "maxMsncNum", + "mscsLayerProtocolSupport" + ], + "properties": { + "maxMscsNums": { + "description": "Maximum number of MSCS that the WIM can manage.\n", + "type": "object", + "required": [ + "numMscs" + ], + "properties": { + "numMscs": { + "description": "Maximum number of MSCS.\n", + "type": "integer" + }, + "criteriaNumMscs": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } + }, + "maxMsncNum": { + "description": "Maximum number of MSNC that the WIM can manage\n", + "type": "object", + "required": [ + "numMsnc" + ], + "properties": { + "numMsnc": { + "description": "Maximum number of MSNC..\n", + "type": "integer" + }, + "criteriaNumMsnc": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } + }, + "mscsLayerProtocolSupport": { + "description": "List of protocols of particular layers used to realize an MSCS that are supported by the WIM.\nPermitted values:\n - EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432.\n - EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214.\n - VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified\n in IETF RFC 4761 and IETF RFC.\n - VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2\n Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074.\n - VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074.\n - BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364.\n", + "type": "string", + "enum": [ + "EVPN_BGP_MPLS", + "EVPN_VPWS", + "VPLS_BGP", + "VPLS_LDP_L2TP", + "VPWS_LDP_L2TP", + "BGP_IP_VPN" + ] + } + } + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "required": [ + "self", + "manoServiceInterfaces", + "peerEntities", + "changeState", + "changeStateOpOccs" + ], + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "manoServiceInterfaces": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "peerEntities": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "changeState": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "changeStateOpOccs": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.schema.json index bcedca867..94ea56821 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.schema.json @@ -1,215 +1,215 @@ -{ - "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", - "type": "object", - "required": [ - "id", - "name", - "type", - "standardVersion", - "providerSpecificApiVersion", - "apiVersion", - "apiEndpoint", - "supportedOperations", - "interfaceState" - ], - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "providerSpecificApiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Exposed API endpoint of the interface.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "apiUri" - ] - }, - "maxConcurrentIntOpNumber": { - "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", - "type": "integer" - }, - "supportedOperations": { - "description": "Information about supported operations of this interface.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "operationName": { - "description": "Name of the operation supported on the interface.\n", - "type": "string" - }, - "maxConcurrentOpNumber": { - "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", - "type": "integer" - } - }, - "required": [ - "operationName" - ] - }, - "minItems": 1 - }, - "interfaceState": { - "description": "State of the NFV-MANO service interface.\n", - "properties": { - "operationalState": { - "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } - }, - "required": [ - "operationalState", - "administrativeState", - "usageState" - ] - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ], - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "tlsTunnelCipherSuites" - ] - } - } - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } +{ + "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "providerSpecificApiVersion", + "apiVersion", + "apiEndpoint", + "supportedOperations", + "interfaceState" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "providerSpecificApiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Exposed API endpoint of the interface.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + }, + "required": [ + "apiUri" + ] + }, + "maxConcurrentIntOpNumber": { + "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", + "type": "integer" + }, + "supportedOperations": { + "description": "Information about supported operations of this interface.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "operationName": { + "description": "Name of the operation supported on the interface.\n", + "type": "string" + }, + "maxConcurrentOpNumber": { + "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", + "type": "integer" + } + }, + "required": [ + "operationName" + ] + }, + "minItems": 1 + }, + "interfaceState": { + "description": "State of the NFV-MANO service interface.\n", + "properties": { + "operationalState": { + "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + } + }, + "required": [ + "operationalState", + "administrativeState", + "usageState" + ] + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } + } + }, + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.schema.json index 696a8c11e..26199703f 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.schema.json @@ -1,105 +1,105 @@ -{ - "description": "This type represents attribute modifications that were performed on an Individual NFV-MANO service interface\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoServiceInterfaceModificationRequest\" data structure. If applicable, additional attributes of the \"ManoServiceInterface\" data structure that were modified implicitly shall also be provided. * NOTE:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all\n to the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided\n in a response message.\n", - "type": "object", - "properties": { - "name": { - "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoServiceInterface\", as defined in clause 5.6.2.11.\n", - "type": "string" - }, - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ], - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "tlsTunnelCipherSuites" - ] - } - } - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } +{ + "description": "This type represents attribute modifications that were performed on an Individual NFV-MANO service interface\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoServiceInterfaceModificationRequest\" data structure. If applicable, additional attributes of the \"ManoServiceInterface\" data structure that were modified implicitly shall also be provided. * NOTE:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all\n to the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided\n in a response message.\n", + "type": "object", + "properties": { + "name": { + "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoServiceInterface\", as defined in clause 5.6.2.11.\n", + "type": "string" + }, + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } + } + }, + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.schema.json index 5ba68faae..8b6194d71 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.schema.json @@ -1,218 +1,218 @@ -{ - "type": "array", - "items": { - "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", - "type": "object", - "required": [ - "id", - "name", - "type", - "standardVersion", - "providerSpecificApiVersion", - "apiVersion", - "apiEndpoint", - "supportedOperations", - "interfaceState" - ], - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "providerSpecificApiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Exposed API endpoint of the interface.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "apiUri" - ] - }, - "maxConcurrentIntOpNumber": { - "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", - "type": "integer" - }, - "supportedOperations": { - "description": "Information about supported operations of this interface.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "operationName": { - "description": "Name of the operation supported on the interface.\n", - "type": "string" - }, - "maxConcurrentOpNumber": { - "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", - "type": "integer" - } - }, - "required": [ - "operationName" - ] - }, - "minItems": 1 - }, - "interfaceState": { - "description": "State of the NFV-MANO service interface.\n", - "properties": { - "operationalState": { - "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } - }, - "required": [ - "operationalState", - "administrativeState", - "usageState" - ] - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ], - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "tlsTunnelCipherSuites" - ] - } - } - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } - } +{ + "type": "array", + "items": { + "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "providerSpecificApiVersion", + "apiVersion", + "apiEndpoint", + "supportedOperations", + "interfaceState" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "providerSpecificApiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Exposed API endpoint of the interface.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + }, + "required": [ + "apiUri" + ] + }, + "maxConcurrentIntOpNumber": { + "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", + "type": "integer" + }, + "supportedOperations": { + "description": "Information about supported operations of this interface.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "operationName": { + "description": "Name of the operation supported on the interface.\n", + "type": "string" + }, + "maxConcurrentOpNumber": { + "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", + "type": "integer" + } + }, + "required": [ + "operationName" + ] + }, + "minItems": 1 + }, + "interfaceState": { + "description": "State of the NFV-MANO service interface.\n", + "properties": { + "operationalState": { + "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + } + }, + "required": [ + "operationalState", + "administrativeState", + "usageState" + ] + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } + } + }, + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.schema.json index 75811a050..2e02794be 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.schema.json @@ -1,212 +1,212 @@ -{ - "type": "array", - "items": { - "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", - "type": "object", - "required": [ - "id", - "peerEntityId", - "name", - "type", - "peerEntityState" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "peerEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM", - "WIM", - "EM", - "OSS", - "WIM" - ] - }, - "description": { - "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "consumedManoInterfaces": { - "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", - "type": "object", - "additionalProperties": { - "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", - "type": "object", - "required": [ - "id", - "name", - "type", - "standardVersion", - "apiVersion", - "apiEndpoint" - ], - "properties": { - "name": { - "description": "Human-readable name of the NFV-MANO interface.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "apiUri" - ] - }, - "securityInfo": { - "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - } - } - } - } - } - }, - "peerEntityState": { - "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", - "type": "object", - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - } - }, - "required": [ - "operationalState", - "administrativeState" - ] - } - } - } +{ + "type": "array", + "items": { + "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", + "type": "object", + "required": [ + "id", + "peerEntityId", + "name", + "type", + "peerEntityState" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "peerEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM", + "EM", + "OSS", + "WIM" + ] + }, + "description": { + "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "consumedManoInterfaces": { + "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "apiVersion", + "apiEndpoint" + ], + "properties": { + "name": { + "description": "Human-readable name of the NFV-MANO interface.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + }, + "required": [ + "apiUri" + ] + }, + "securityInfo": { + "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", + "type": "string", + "format": "uri" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", + "type": "string", + "format": "uri" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + } + } + } + } + } + }, + "peerEntityState": { + "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", + "type": "object", + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + } + }, + "required": [ + "operationalState", + "administrativeState" + ] + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.schema.json index e168b2a11..67233fbbb 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.schema.json @@ -1,209 +1,209 @@ -{ - "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", - "type": "object", - "required": [ - "id", - "peerEntityId", - "name", - "type", - "peerEntityState" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "peerEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM", - "WIM", - "EM", - "OSS", - "WIM" - ] - }, - "description": { - "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "consumedManoInterfaces": { - "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", - "type": "object", - "additionalProperties": { - "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", - "type": "object", - "required": [ - "id", - "name", - "type", - "standardVersion", - "apiVersion", - "apiEndpoint" - ], - "properties": { - "name": { - "description": "Human-readable name of the NFV-MANO interface.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "apiUri" - ] - }, - "securityInfo": { - "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - } - } - } - } - } - }, - "peerEntityState": { - "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", - "type": "object", - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - } - }, - "required": [ - "operationalState", - "administrativeState" - ] - } - } +{ + "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", + "type": "object", + "required": [ + "id", + "peerEntityId", + "name", + "type", + "peerEntityState" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "peerEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM", + "EM", + "OSS", + "WIM" + ] + }, + "description": { + "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "consumedManoInterfaces": { + "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "apiVersion", + "apiEndpoint" + ], + "properties": { + "name": { + "description": "Human-readable name of the NFV-MANO interface.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + }, + "required": [ + "apiUri" + ] + }, + "securityInfo": { + "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", + "type": "string", + "format": "uri" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", + "type": "string", + "format": "uri" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + } + } + } + } + } + }, + "peerEntityState": { + "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", + "type": "object", + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + } + }, + "required": [ + "operationalState", + "administrativeState" + ] + } + } } \ No newline at end of file -- GitLab From c6330cb3cc79491c686a66bde4ab5cb5a6cd354a Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 17:23:47 +0500 Subject: [PATCH 07/22] update applicability description for POST subscription - unprocessable entity --- .../Subscriptions.robot | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 4cb9a4901..3680ae513 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -180,7 +180,7 @@ POST Create a new subscription - Unprocessable Entity ... Pre-conditions: none ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO - ... Applicability: none + ... Applicability: Notification endpoint test by NFV-MANO fails. ... Post-Conditions: none Send Post Request for Subscription with Unreachable callbackUri Check HTTP Response Status Code Is 422 -- GitLab From 5495a449aa671dd5bbe72547d9a8e921b1ca7635 Mon Sep 17 00:00:00 2001 From: hammad zafar Date: Wed, 13 Oct 2021 17:54:48 +0500 Subject: [PATCH 08/22] removed unused OpenAPI yaml --- .../NFVMANOCimKeywords.robot | 1 + ...onfigurationInformationManagement-API.yaml | 33445 ---------------- .../Subscriptions.robot | 4 +- 3 files changed, 3 insertions(+), 33447 deletions(-) delete mode 100644 SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot index cb1eb6210..a88658791 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot @@ -676,6 +676,7 @@ Send Post Request for Subscription ... Check Notification Endpoint Send Post Request for Subscription with Unreachable callbackUri + Log Trying to create a subscription for an unreachable Notification Endpoint Set headers {"Content-Type": "${CONTENT_TYPE_JSON}"} Set headers {"Accept": "${ACCEPT_JSON}"} Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": ${AUTHORIZATION}"} diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml b/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml deleted file mode 100644 index 3fed77a90..000000000 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml +++ /dev/null @@ -1,33445 +0,0 @@ -openapi: 3.0.2 -info: - version: '1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1' - title: SOL009 - NFV-MANO Configuration and Information Management Interface - description: > - SOL009 - NFV-MANO Configuration and Information 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' - contact: - name: NFV-SOL WG -externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: >- - https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf -servers: - - url: 'http://0.0.0.0/nfvmanocim/v1' - description: | - API HTTP Server - - url: 'https://0.0.0.0/nfvmanocim/v1' - description: | - API HTTPS Server -paths: - /api_versions: - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: false - schema: - type: string - - name: Authorization - description: 'The authorization token for the request. Reference: IETF RFC 7235' - in: header - required: false - schema: - type: string - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow - the provisions specified in table 4.6.3.3.3.2-1 for request and response - data structures, and response codes. URI query parameters are not - supported. - responses: - '200': - description: > - 200 OK - - API version information was read successfully. The response body - shall contain 4.4 API version information, as defined in clause - 4.4.1.13. - content: - application/json: - schema: - description: | - This type represents API version information. - type: object - required: - - uriPrefix - - apiVersions - properties: - uriPrefix: - description: > - Specifies the URI prefix for the API, in the following - form {apiRoot}/{apiName}/{apiMajorVersion}/. - type: string - apiVersions: - description: > - Version(s) supported for the API signaled by the uriPrefix - attribute. - type: array - items: - type: object - required: - - version - properties: - version: - description: > - Identifies a supported version. The value of the - version attribute shall be a version identifier as - specified in clause 9.1 (SOL013). - type: string - isDeprecated: - description: > - If such information is available, this attribute - indicates whether use of the version signaled by the - version attribute is deprecated (true) or not - (false). - - A deprecated version is still supported by the API - producer but is recommended not to be used any - longer. When a version is no longer supported, it - does not appear in the response body. - type: boolean - retirementDate: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - schema: - type: string - maximum: 1 - minimum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '413': - description: > - 413 PAYLOAD TOO LARGE - - If the payload body of a request is larger than the amount of data - the API producer is willing or able to process, it shall respond - with this response code, following the provisions in IETF RFC 7231 - for the use of the "Retry-After" HTTP header and for closing the - connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '414': - description: > - 414 URI TOO LONG - - If the request URI of a request is longer than the API producer is - willing or able to process, it shall respond with this response - code. This condition can e.g. be caused by passing long queries in - the request URI of a GET request. The "ProblemDetails" structure may - be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '416': - description: | - 416 Range Not Satisfiable - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '429': - description: > - 429 TOO MANY REQUESTS - - If the API consumer has sent too many requests in a defined period - of time and the API producer is able to detect that condition ("rate - limiting"), the API producer shall respond with this response code, - following the provisions in IETF RFC 6585 [17] for the use of the - "Retry-After" HTTP header. The "ProblemDetails" structure shall be - provided and shall include in the "detail" attribute more - information about the source of the problem. - - The period of time and allowed number of requests are configured - within the API producer by means outside the scope of the present - document. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity: - get: - description: > - Retrives information about an NFV-MANO functional entity by reading the - NFV-MANO entity resource. This method shall follow the provisions - specified in the tables 5.5.3.3.2-1 and 5.5.3.3.2-2 for URI query - parameters, request and response data structures, and response - codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when configuration and information about the - NFV-MANO functional entity has been read successfully. The response - body shall contain a representation of the NFV-MANO functional - entity, as defined in clause 5.6.2.2. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: > - Human-readable description of the NFV-MANO functional - entity. - - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional - entity. It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional - entity. $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component - realizing part of an NFV-MANO functional entity. It is - optional for the API producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on - the NFV-MANO functional entity component. The - identifier of the ManoService is referred. A - service may depend on multiple components. Multiple - services may depend on the same component. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the - NFV-MANO functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO - service provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO service. - - This attribute can be modified with the PATCH - method. - type: string - description: - description: > - Human-readable description of the NFV-MANO service. - - This attribute can be modified with the PATCH - method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service - interface" resources with information about the - associated interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource - using an absolute URI. - type: object - required: - - href - properties: - href: - description: > - String formatted according to IETF RFC - 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional - entity’s application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an - NFVO entity, and that can be relevant to more than one - NFV-MANO service offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of - this parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded - on the NFVO. - - NOTE: If this attribute is not present, the value of - this parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a - VNFM entity, and that can be relevant to more than one - NFV-MANO service offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. - to determine the compatibility of a VNF with certain - VNFM according to the vnfmInfo attribute in the VNFD - (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a - VIM entity, and that can be relevant to more than one - NFV-MANO service offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies the NFV-MANO entity resource. Changes to the various - configuration and information attributes are applied to the NFV-MANO - functional entity, and are reflected in the representation of this - resource. This method shall follow the provisions specified in the - tables 5.5.3.3.4-1 and 5.5.3.3.4-2 for URI query parameters, request - and response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the NFV-MANO configuration and information - modification, as defined in clause 5.6.2.3. The Content-Type header - shall be set to "application/merge-patch+json" according to IETF RFC - 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute - array in the "ManoEntityConfigurableParams", as defined - below this table. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case - of an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the - "clockSyncs" attribute array in the - "ManoEntityConfigurableParams", as defined below this - table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" - attribute array in the "ManoEntity", as defined below this - table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the modification of configuration on the - NFV-MANO functional entity has been accepted and completed. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on the "NFV-MANO entity" resource of the producer - NFV-MANO functional entity. The attributes that can be - included consist of those requested to be modified explicitly - in the "ManoConfigModificationRequest" data structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoEntity", as defined in clause - 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in - clause 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", - as defined in clause 5.6.2.3. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock - synchronization. Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case - of an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 - address, string that consists of groups of zero - to four hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as - an object. It shall comply with the provisions - defined in clause 4 of IETF RFC 8259. In the - following example, a list of key-value pairs with - four keys ("aString", "aNumber", "anArray" and - "anObject") is provided to illustrate that the - values associated with different keys can be of - different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of - certain entries in "clockSyncs" attribute in - "ManoEntityConfigurableParams", as defined in clause - 5.6.2.3. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as - defined in clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - name: - description: > - If present, this attribute signals modification of - the "name" attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of - the "description" attribute in the "ManoService". - type: string - required: - - id - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "NFV-MANO entity" resource. - - Typically, this is due to the fact that another configuration and - information modification is ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity/change_state: - post: - description: > - Requests to change the state of the NFV-MANO functional entity - application. - - This method shall follow the provisions specified in the tables - 5.5.7.3.1-1 and 5.5.7.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state - of a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - responses: - '202': - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "Individual change state - operation occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the - error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity/mano_interfaces: - get: - description: > - Queries information about multiple NFV-MANO service interfaces of the - NFV-MANO functional entity. This method shall follow the provisions - specified in the tables 5.5.10.3.2-1 and 5.5.10.3.2-2 for URI query - parameters, request and response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the ManoServiceInterface and in - data types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ManoServiceInterface structure in the response body if this - parameter is provided, or none of the parameters "all_fields," - "fields", "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about zero or more NFV-MANO - service interfaces has been queried successfully. - - The response body shall contain in an array the representations of - zero or more NFV-MANO service interfaces, as defined in clause - 5.6.2.11. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents an individual NFV-MANO service - interface produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: > - Information about supported operations of this - interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing - the SSL or TLS negotiation with the API client. - Valid values of cipher suites are defined in - IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/mano_entity/mano_interfaces/{manoServiceInterfaceId}': - parameters: - - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - retrieves information about an NFV-MANO service interface of the - producer NFV-MANO functional entity by reading an "Individual NFV-MANO - service interface" resource. - - This method shall follow the provisions specified in the tables - 5.5.11.3.2-1 and 5.5.11.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual NFV-MANO - service interface has been read successfully. - - The response body shall contain a representation of the NFV-MANO - service interface, as defined in clause 5.6.2.11. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant to - (see also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall - be present for ETSI NFV specified RESTful NFV-MANO - APIs. The major version is defined in the standard - the interface is compliant to (see also clause 4.1 of - ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It - shall comply with the provisions defined in clause 4 of - IETF RFC 8259. In the following example, a list of - key-value pairs with four keys ("aString", "aNumber", - "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of - different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies an "Individual NFV-MANO service interface" resource. - - Changes to the configurable parameters of the corresponding NFV-MANO - service interface are applied to the information managed by the - producer NFV-MANO functional entity and reflected in the representation - of this resource. - - This method shall follow the provisions specified in the tables - 5.5.11.3.4-1 and 5.5.11.3.4-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the modification of configuration parameters of the - NFV-MANO service interface, as defined in clause 5.6.2.12. - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer - NFV-MANO functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual NFV-MANO service interface" - resource, as defined in clause 5.6.2.13. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on an Individual NFV-MANO service interface" - resource. The attributes that can be included consist of - those requested to be modified explicitly in the - "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the - "ManoServiceInterface" data structure that were modified - implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoServiceInterface", as defined in - clause 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It - shall comply with the provisions defined in clause 4 of - IETF RFC 8259. In the following example, a list of - key-value pairs with four keys ("aString", "aNumber", - "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of - different type. - type: object - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual NFV-MANO service interface" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/mano_entity/mano_interfaces/{manoServiceInterfaceId}/change_state': - parameters: - - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - post: - description: > - Requests to change the state of the NFV-MANO service interface produced - by the NFV-MANO functional entity. - - This method shall follow the provisions specified in the tables - 5.5.12.3.1-1 and 5.5.12.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state - of a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - responses: - '202': - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for - processing. - - The response body shall be empty. - - The HTTP response shall include a “Location” HTTP header that - contains the URI of the newly-created "Individual change state - operation occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the - error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /subscriptions: - post: - description: > - Creates a new subscription. - - This method shall follow the provisions specified in the tables - 5.5.4.3.1-1 and 5.5.4.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Details of the subscription to be created, as defined in clause - 5.6.2.5-1. - content: - application/json: - schema: - description: > - This type represents a subscription request related to - notifications about NFV-MANO configuration and information - management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their associated - managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference to - NFV-MANO services in a filter. They should not be - used together in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed in - this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed in - this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization - which 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The clientId and - clientPassword passed in a subscription shall not be - the same as the clientId and clientPassword that are - used to obtain authorization for API requests. - Client credentials may differ between subscriptions. - The value of clientPassword should be generated by a - random process. - 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. The clientId and - clientPassword passed in a subscription shall not be - the same as the clientId and clientPassword that are - used to obtain authorization for API requests. - Client credentials may differ between subscriptions. - The value of clientPassword should be generated by a - random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when the subscription has been created - successfully. - - The response body shall contain a representation of the created - "Individual subscription" resource. - - The HTTP response shall include a "Location" HTTP header that - points to the created "Individual subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual subscription" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference - to NFV-MANO services in a filter. They should not - be used together in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed - in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed - in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '303': - description: > - 303 SEE OTHER - - SShall be returned when a subscription with the same callbackURI - and the same filter already exists and the policy of NFV-MANO - functional entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that - contains the resource URI of the existing "Individual subscription" - resource. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual subscription" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: > - queries the list of active subscriptions of the API consumer that - invokes the method. It can be used, e.g., for resynchronization after - error situations. - - This method shall follow the provisions specified in the tables - 5.5.4.3.2-1 and 5.5.4.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the CimSubscription and in data - types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations of - all active subscriptions of the functional block that invokes the - method, i.e., zero or more representations of NFV-MANO - configuration and information management subscriptions as defined - in clause 5.6.2.6. - - If the "filter" URI parameter was supplied in the request, the data - in the response body shall have been transformed according to the - rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being - globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the - respective type within a NFV-MANO functional - entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to - reference to NFV-MANO services in a filter. They - should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity - produced interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the - respective type within a NFV-MANO functional - entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity - produced interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives - to reference to NFV-MANO functional entity - consumed interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives - to reference to NFV-MANO functional entity - consumed interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/subscriptions/{subscriptionId}': - parameters: - - name: subscriptionId - in: path - description: Identifier of the subscription - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - Retrieves information about a subscription by reading an "Individual - subscription" resource. - - This method shall follow the provisions specified in the tables - 5.5.5.3.2-1 and 5.5.5.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual subscription - has been read successfully. - - The response body shall contain a representation of the "Individual - subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference - to NFV-MANO services in a filter. They should not - be used together in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed - in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed - in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: > - Terminates an individual subscription. - - This method shall follow the provisions specified in the tables - 5.5.5.3.5-1 and 5.5.5.3.5-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has - been deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /change_state_ops: - get: - description: > - The API consumer can use the GET method to query status information - about multiple change state operation occurrences. - - This method shall follow the provisions specified in the tables - 5.5.8.3.2-1 and 5.5.8.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the ChangeStateOpOcc and in data - types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ChangeStateOpOcc structure in the response body if this parameter - is provided, or none of the parameters "all_fields," "fields", - "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when status information for zero or more "change - state operation occurrences" has been queried successfully. - - The response body shall contain in an array the status information - about zero or more "Individual change state operation occurrences", - as defined in clause 5.6.2.9. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a - managed object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted - values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request - data type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual - resource, and may be present according to the chosen - attribute selector parameter if this data type is - returned in a response to a query of a container - resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/change_state_ops/{changeStateOpOccId}': - parameters: - - name: changeStateOpOccId - in: path - description: Identifier of the change state operation occurrence - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - The API consumer can use the GET method to retrieve status information - about a change state operation occurrence by reading an "Individual - change state operation occurrence" resource. - - This method shall follow the provisions specified in the tables - 5.5.9.3.2-1 and 5.5.9.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an "Individual change - state operation occurrence" resource has been read successfully. - - The response body shall contain status information about a change - state operation occurrence, as defined in clause 5.6.2.9. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted - values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request - data type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual resource, - and may be present according to the chosen attribute - selector parameter if this data type is returned in a - response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /peer_entities: - post: - description: > - Creates in the producer NFV-MANO functional entity a new peer entity - resource which contains configuration and information with regards to - the peer functional entity. - - This method shall follow the provisions specified in the tables - 5.5.13.3.1-1 and 5.5.13.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: | - The peer entity creation parameters, as defined in clause 5.6.2.14. - content: - application/json: - schema: - description: > - This type represents request parameters for the creation of a - new peer entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when a new "Individual peer entity" resource has - been created successfully. - - The response body shall contain a representation of the created - resource with regards to a peer entity, as defined in clause - 5.6.2.15. - - The HTTP response shall include a “Location” HTTP header that - points to the created "Individual peer entity" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual peer entity" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: > - Queries information and configuration in the producer NFV-MANO - functional entity with regards to multiple peer entities. - - This method shall follow the provisions specified in the tables - 5.5.13.3.2-1 and 5.5.13.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the PeerEntity and in data types - referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the PeerEntity - structure in the response body if this parameter is provided, or - none of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about zero or more peer entities - has been queried successfully. - - The response body shall contain in an array the resource - representations of zero or more peer entities, as defined in clause - 5.6.2.15. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - peerEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: > - Human-readable description of the peer functional - entity. - - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the - API. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The major version is - defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used - by the API consumer accessing the API. - - The support of authorization methods for the - API consumer is specified in clause 8.3.6 of - ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC - 5246. - OAUTH2: Using access token, as defined - by the OAuth 2.0 specification in IETF RFC - 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be - declared as supported by the API consumer - when performing the SSL or TLS - negotiation with the authorization server. - Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the - use of TLS tunnel. Shall be present if - authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be - declared as supported by the API consumer - when performing the SSL or TLS negotiation - with the API producer. Valid values of - cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the - API consumer when creating the resource or when - updating it with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/peer_entities/{peerEntityId}': - parameters: - - name: peerEntityId - in: path - description: Identifier of the peer entity - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - Retrieves information and configuration hold in the producer NFV-MANO - functional entity with regards to a peer entity by reading an - individual peer entity resource. - - This method shall follow the provisions specified in the tables - 5.5.14.3.2-1 and 5.5.14.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual peer - functional entity has been read successfully. - - The response body shall contain a resource representation of the - peer functional entity, as defined in clause 5.6.2.15. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies configuration and information of the producer NFV-MANO - functional entity with regards to a peer functional entity by updating - the corresponding "Individual peer entity" resource. - - Changes to the configurable parameters of the corresponding peer entity - are applied to the information managed by the producer NFV-MANO - functional entity and reflected in the representation of this resource. - - This method shall follow the provisions specified in the tables - 5.5.14.3.4-1 and 5.5.14.3.4-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the modification of configuration parameters of the - peer functional entity, as defined in clause 5.6.2.16 - - The Content-Type header shall be set to - "application/merge-patch+json" according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or - "null" to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " - PeerEntity ", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual peer entity" resource, as defined - in clause 5.6.2.17. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on an "Individual peer entity" resource. The - attributes that can be included consist of those requested to - be modified explicitly in the - "PeerEntityConfigModificationRequest" data structure. If - applicable, additional attributes of the "PeerEntity" data - structure that were modified implicitly shall also be - provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in - clause 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of - certain entries in the "consumedManoInterfaces" attribute - in "PeerEntity", as defined in clause 5.6.2.15. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual peer entity" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: > - Ddeletes an individual peer entity resource. By deleting such a - resource in the producer NFV-MANO functional entity representing a peer - NFV-MANO entity, the configuration and information with regards to such - peer entity is deleted. Consequently, the peering relationship between - the producer NFV-MANO functional entity and the peer entity is - terminated, i.e., the producer NFV-MANO functional entity does not have - the necessary information to communicate/interact with the peer entity. - - This method shall follow the provisions specified in the tables - 5.5.14.3.5-1 and 5.5.14.3.5-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: > - 204 NO CONTENT - - Shall be returned when the "Individual peer entity" resource has - been deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual peer entity" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 -components: - schemas: - ManoEntity: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional entity. - It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional entity. $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component realizing - part of an NFV-MANO functional entity. It is optional for the API - producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the - NFV-MANO functional entity component. The identifier of the - ManoService is referred. A service may depend on multiple - components. Multiple services may depend on the same - component. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the NFV-MANO - functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO service - provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" - resources with information about the associated - interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional entity’s - application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an NFVO - entity, and that can be relevant to more than one NFV-MANO service - offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM - entity, and that can be relevant to more than one NFV-MANO service - offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to - determine the compatibility of a VNF with certain VNFM - according to the vnfmInfo attribute in the VNFD (see table - 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a VIM - entity, and that can be relevant to more than one NFV-MANO service - offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - ManoConfigModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute array - in the "ManoEntityConfigurableParams", as defined below this - table. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the "clockSyncs" - attribute array in the "ManoEntityConfigurableParams", as defined - below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" attribute - array in the "ManoEntity", as defined below this table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - ManoConfigModifications: - description: > - This type represents attribute modifications that were performed on the - "NFV-MANO entity" resource of the producer NFV-MANO functional entity. - The attributes that can be included consist of those requested to be - modified explicitly in the "ManoConfigModificationRequest" data - structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoEntity", as defined in clause 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in clause - 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of certain entries - in "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as defined in - clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - If present, this attribute signals modification of the "name" - attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of the - "description" attribute in the "ManoService". - type: string - required: - - id - CimSubscriptionRequest: - description: > - This type represents a subscription request related to notifications - about NFV-MANO configuration and information management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The - clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are - used to obtain authorization for API requests. Client - credentials may differ between subscriptions. The value of - clientPassword should be generated by a random process. - 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. The - clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are - used to obtain authorization for API requests. Client - credentials may differ between subscriptions. The value of - clientPassword should be generated by a random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - CimSubscription: - description: > - This type represents a subscription related to notifications about - NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - ChangeStateRequest: - description: > - This type represents request parameters for changing the state of a - managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - ChangeStateOpOcc: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according to IETF - RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according to IETF - RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed object of - a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if attribute - "manoEntityComponents" in "ManoEntity" is supported by the API - producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: | - An identifier with the intention of being globally unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This attribute shall - be formatted according to the request data type of the related - change state operation. - - The following mapping between operationType and the data type of - this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is returned in a - response to reading an individual resource, and may be present - according to the chosen attribute selector parameter if this data - type is returned in a response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - ManoServiceInterface: - description: > - This type represents an individual NFV-MANO service interface produced - by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO functional entity interface. - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the NFV-MANO - functional entity. Valid values are defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - {apiName} of each interface is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be present - for ETSI NFV specified RESTful NFV-MANO APIs. The major version - is defined in the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - ManoServiceInterfaceModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer NFV-MANO - functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - ManoServiceInterfaceModifications: - description: > - This type represents attribute modifications that were performed on an - Individual NFV-MANO service interface" resource. The attributes that - can be included consist of those requested to be modified explicitly in - the "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the "ManoServiceInterface" data - structure that were modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - CreatePeerEntityRequest: - description: > - This type represents request parameters for the creation of a new peer - entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO functional - entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - PeerEntity: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO functional - entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API consumer - when creating the resource or when updating it with the PATCH - method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - PeerEntityConfigModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or "null" - to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " PeerEntity ", as - defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - PeerEntityConfigModifications: - description: > - This type represents attribute modifications that were performed on an - "Individual peer entity" resource. The attributes that can be included - consist of those requested to be modified explicitly in the - "PeerEntityConfigModificationRequest" data structure. If applicable, - additional attributes of the "PeerEntity" data structure that were - modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "PeerEntity", as defined in clause 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of certain entries - in the "consumedManoInterfaces" attribute in "PeerEntity", as - defined in clause 5.6.2.15. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - ManoConfigurableParams: - description: | - # Warning: No definition found in the document ManoConfigurableParams - ManoEntityComponent: - description: > - This type represents information of a deployed component realizing part - of an NFV-MANO functional entity. It is optional for the API producer - to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the NFV-MANO - functional entity component. The identifier of the ManoService is - referred. A service may depend on multiple components. Multiple - services may depend on the same component. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - required: - - id - ManoService: - description: > - This type represents information about an NFV-MANO service provided by - the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" resources - with information about the associated interfaces to the - NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an absolute - URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - NfvoSpecificInfo: - description: > - This type represents information attributes specific to an NFVO entity, - and that can be relevant to more than one NFV-MANO service offered by - an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - VnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM entity, - and that can be relevant to more than one NFV-MANO service offered by a - VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to determine - the compatibility of a VNF with certain VNFM according to the - vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS - NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - VimSpecificInfo: - description: > - This type represents information attributes specific to a VIM entity, - and that can be relevant to more than one NFV-MANO service offered by a - VIM entity. - type: object - ManoEntityConfigurableParams: - description: > - This type represents list of parameters that can be configured on the - NFV MANO functional entity. - type: object - properties: - clockSyncs: - description: >- - Properties of the clock synchronization to be used by the NFV-MANO - functional entity. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - minItems: 1 - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - required: - - clockSyncs - - defaultLogCompileBySizeValue - - defaultLogCompileByTimerValue - ConsumedManoInterfaceInfo: - description: > - This type represents an interface consumed by the producer NFV MANO - functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the NFV-MANO - functional entity. Valid values are defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and path - where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - {apiName} of each interface is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be present - for ETSI NFV specified RESTful NFV-MANO APIs. The major version - is defined in the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for accessing an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API consumer - accessing the API. - - The support of authorization methods for the API consumer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by - TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as - defined by the OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When used, - the request to the WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI GS - NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API consumer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API consumer when performing the SSL or TLS negotiation - with the API producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - CimNotificationsFilter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match NFV-MANO - functional entities and their associated managed objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced interfaces - with an instance identifier listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference to - NFV-MANO functional entity produced interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced interfaces - with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference to - NFV-MANO functional entity produced interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed interfaces - with an instance identifier listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference to - NFV-MANO functional entity consumed interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed interfaces - with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference to - NFV-MANO functional entity consumed interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - ClockSyncInfo: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an IPV4 - address, string that consists of four decimal integers separated - by dots, each integer ranging from 0 to 255. In case of an IPV6 - address, string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - required: - - id - - type - ServerInterfaceSecurityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by the - API producer when performing the SSL or TLS negotiation with the - API client. Valid values of cipher suites are defined in IETF - RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - ClientInterfaceSecurityInfo: - description: > - This type represents security related information for accessing an - NFV-MANO service interface produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API consumer - accessing the API. - - The support of authorization methods for the API consumer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS - 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by - the OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When used, the - request to the WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI GS - NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by the - API consumer when performing the SSL or TLS negotiation with - the authorization server. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as supported by the - API consumer when performing the SSL or TLS negotiation with - the API producer. Valid values of cipher suites are defined in - IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - ManoServiceInterfaceTypeShortName: - description: "For the RESTful NFV-MANO APIs, valid values are all values for \"apiName\" as defined in ETSI GS NFV-SOL 002, ETSI GS NFV-SOL 003, and ETSI GS NFV-SOL 005.\nFor the NFV-MANO service interfaces for which no API is specified by ETSI NFV, valid values are defined in table 5.6.4.3-1.\nNOTE:\tThe table is expected to be updated, by removing the corresponding listed entries, once the interfaces are specified as a RESTful NFV-MANO API. \n" - type: string - UsageStateEnumType: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - ChangeOperationalStateEnumType: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - ChangeAdministrativeStateEnumType: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - InterfaceOperationalStateEnumType: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - StopEnumType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - ManoEntityEnumType: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - PeerEntityEnumType: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - parameters: - filter.ManoServiceInterface: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the ManoServiceInterface and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.CimSubscription: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the CimSubscription and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.ChangeStateOpOcc: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the ChangeStateOpOcc and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.PeerEntity: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the PeerEntity and in data types - referenced from it shall be supported by the NFV-MANO functional entity - in the expression. - in: query - required: false - schema: - type: string - exclude_default.ManoServiceInterface: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ManoServiceInterface structure in the response body if this parameter - is provided, or none of the parameters "all_fields," "fields", - "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.CimSubscription: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the CimSubscription - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.ChangeStateOpOcc: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the ChangeStateOpOcc - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.PeerEntity: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the PeerEntity - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - manoServiceInterfaceId: - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - subscriptionId: - name: subscriptionId - in: path - description: Identifier of the subscription - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - changeStateOpOccId: - name: changeStateOpOccId - in: path - description: Identifier of the change state operation occurrence - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - name: peerEntityId - in: path - description: Identifier of the peer entity - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - requestBodies: - ModifyManoEntityRequest: - description: > - Parameters for the NFV-MANO configuration and information modification, - as defined in clause 5.6.2.3. The Content-Type header shall be set to - "application/merge-patch+json" according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute - array in the "ManoEntityConfigurableParams", as defined below - this table. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of - an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the - "clockSyncs" attribute array in the - "ManoEntityConfigurableParams", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" attribute - array in the "ManoEntity", as defined below this table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - required: true - ChangeManoEntityStateRequest: - description: | - Parameters for the change state operation, as defined in clause 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state of - a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - ModifyManoEnityInterfaceRequest: - description: > - Parameters for the modification of configuration parameters of the - NFV-MANO service interface, as defined in clause 5.6.2.12. - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer - NFV-MANO functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: true - ChangeManoEntityInterfaceStateRequest: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state of - a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - CimSubscriptionRequest: - description: > - Details of the subscription to be created, as defined in clause - 5.6.2.5-1. - content: - application/json: - schema: - description: > - This type represents a subscription request related to - notifications about NFV-MANO configuration and information - management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which - 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The clientId and clientPassword passed in - a subscription shall not be the same as the clientId - and clientPassword that are used to obtain - authorization for API requests. Client credentials may - differ between subscriptions. The value of - clientPassword should be generated by a random - process. - 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. - The clientId and clientPassword passed in a - subscription shall not be the same as the clientId and - clientPassword that are used to obtain authorization - for API requests. Client credentials may differ - between subscriptions. The value of clientPassword - should be generated by a random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - required: true - CreatePeerEntityRequest: - description: | - The peer entity creation parameters, as defined in clause 5.6.2.14. - content: - application/json: - schema: - description: > - This type represents request parameters for the creation of a new - peer entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - required: true - ModifyPeerEntityRequest: - description: > - Parameters for the modification of configuration parameters of the peer - functional entity, as defined in clause 5.6.2.16 - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or - "null" to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " PeerEntity - ", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: true - responses: - mano_entity.get.200: - description: > - 200 OK - - Shall be returned when configuration and information about the NFV-MANO - functional entity has been read successfully. The response body shall - contain a representation of the NFV-MANO functional entity, as defined - in clause 5.6.2.2. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional - entity. It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional entity. - $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component - realizing part of an NFV-MANO functional entity. It is - optional for the API producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the - NFV-MANO functional entity component. The identifier of - the ManoService is referred. A service may depend on - multiple components. Multiple services may depend on the - same component. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the - NFV-MANO functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO service - provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" - resources with information about the associated - interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional - entity’s application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an - NFVO entity, and that can be relevant to more than one - NFV-MANO service offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on - the NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM - entity, and that can be relevant to more than one NFV-MANO - service offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to - determine the compatibility of a VNF with certain VNFM - according to the vnfmInfo attribute in the VNFD (see - table 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a VIM - entity, and that can be relevant to more than one NFV-MANO - service offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - mano_entity.patch.200: - description: > - 200 OK - - Shall be returned when the modification of configuration on the - NFV-MANO functional entity has been accepted and completed. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on the "NFV-MANO entity" resource of the producer NFV-MANO - functional entity. The attributes that can be included consist of - those requested to be modified explicitly in the - "ManoConfigModificationRequest" data structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoEntity", as defined in clause - 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in clause - 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of - an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of certain - entries in "clockSyncs" attribute in - "ManoEntityConfigurableParams", as defined in clause 5.6.2.3. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as - defined in clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: > - If present, this attribute signals modification of the - "name" attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of the - "description" attribute in the "ManoService". - type: string - required: - - id - mano_entity.patch.409: - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "NFV-MANO - entity" resource. - - Typically, this is due to the fact that another configuration and - information modification is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-change_state.post.202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a "Location" HTTP header that contains - the URI of the newly-created "Individual change state operation - occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - mano_entity-change_state.post.409: - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interfaces.get.200: - description: > - 200 OK - - Shall be returned when information about zero or more NFV-MANO service - interfaces has been queried successfully. - - The response body shall contain in an array the representations of zero - or more NFV-MANO service interfaces, as defined in clause 5.6.2.11. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant to - (see also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. - The major version is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI - GS NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - mano_entity-mano_interfaces.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface.get.200: - description: > - 200 OK - - Shall be returned when information about an individual NFV-MANO service - interface has been read successfully. - - The response body shall contain a representation of the NFV-MANO - service interface, as defined in clause 5.6.2.11. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - mano_entity-mano_interface.patch.200: - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual NFV-MANO service interface" resource, - as defined in clause 5.6.2.13. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on an Individual NFV-MANO service interface" resource. The - attributes that can be included consist of those requested to be - modified explicitly in the - "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the "ManoServiceInterface" - data structure that were modified implicitly shall also be - provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoServiceInterface", as defined in clause - 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - mano_entity-mano_interface.patch.409: - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - NFV-MANO service interface" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface-change_state.post.202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a “Location” HTTP header that contains - the URI of the newly-created "Individual change state operation - occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - mano_entity-mano_interface-change_state.post.409: - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - subscriptions.post.201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - - The response body shall contain a representation of the created - "Individual subscription" resource. - - The HTTP response shall include a "Location" HTTP header that points to - the created "Individual subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual subscription" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscriptions.post.303: - description: > - 303 SEE OTHER - - SShall be returned when a subscription with the same callbackURI and - the same filter already exists and the policy of NFV-MANO functional - entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the existing "Individual subscription" resource. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual subscription" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - subscriptions.get.200: - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations of all - active subscriptions of the functional block that invokes the method, - i.e., zero or more representations of NFV-MANO configuration and - information management subscriptions as defined in clause 5.6.2.6. - - If the "filter" URI parameter was supplied in the request, the data in - the response body shall have been transformed according to the rules - specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their associated - managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference to - NFV-MANO services in a filter. They should not be - used together in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed in - this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed in - this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscriptions.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - subscription.get.200: - description: > - 200 OK - - Shall be returned when information about an individual subscription has - been read successfully. - - The response body shall contain a representation of the "Individual - subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscription.delete.204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has been - deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - change_state_ops.get.200: - description: > - 200 OK - - Shall be returned when status information for zero or more "change - state operation occurrences" has been queried successfully. - - The response body shall contain in an array the status information - about zero or more "Individual change state operation occurrences", as - defined in clause 5.6.2.9. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according - to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according - to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request data - type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual resource, - and may be present according to the chosen attribute - selector parameter if this data type is returned in a - response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - change_state_ops.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - change_state_op.get.200: - description: > - 200 OK - - Shall be returned when information about an "Individual change state - operation occurrence" resource has been read successfully. - - The response body shall contain status information about a change state - operation occurrence, as defined in clause 5.6.2.9. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: | - An identifier with the intention of being globally unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This attribute - shall be formatted according to the request data type of the - related change state operation. - - The following mapping between operationType and the data type - of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is returned - in a response to reading an individual resource, and may be - present according to the chosen attribute selector parameter - if this data type is returned in a response to a query of a - container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - peer_entities.post.201: - description: > - 201 CREATED - - Shall be returned when a new "Individual peer entity" resource has been - created successfully. - - The response body shall contain a representation of the created - resource with regards to a peer entity, as defined in clause 5.6.2.15. - - The HTTP response shall include a “Location” HTTP header that points to - the created "Individual peer entity" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual peer entity" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it with - the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entities.get.200: - description: > - 200 OK - - Shall be returned when information about zero or more peer entities has - been queried successfully. - - The response body shall contain in an array the resource - representations of zero or more peer entities, as defined in clause - 5.6.2.15. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entities.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.get.200: - description: > - 200 OK - - Shall be returned when information about an individual peer functional - entity has been read successfully. - - The response body shall contain a resource representation of the peer - functional entity, as defined in clause 5.6.2.15. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it with - the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entitie.patch.200: - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual peer entity" resource, as defined in - clause 5.6.2.17. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on an "Individual peer entity" resource. The attributes that can - be included consist of those requested to be modified explicitly - in the "PeerEntityConfigModificationRequest" data structure. If - applicable, additional attributes of the "PeerEntity" data - structure that were modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "PeerEntity", as defined in clause 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of certain - entries in the "consumedManoInterfaces" attribute in - "PeerEntity", as defined in clause 5.6.2.15. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - peer_entitie.patch.409: - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - peer entity" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.delete.204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual peer entity" resource has been - deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - peer_entitie.delete.409: - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - peer entity" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.delete.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 3680ae513..2fe757dd3 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -176,11 +176,11 @@ DELETE Subscriptions - Method not implemented POST Create a new subscription - Unprocessable Entity [Documentation] Test ID: 8.3.1.10.13 ... Test title: POST Create a new Subscription - Unprocessable Entity - ... Test objective: The objective is to test that for a POST request for a new subscription, if the test by NFV-MANO for notification endpoint fails, then error 422 will be returned. + ... Test objective: The objective is to test that a new subscription is not created if the notification endpoint is unreachable by the NFV-MANO. ... Pre-conditions: none ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO - ... Applicability: Notification endpoint test by NFV-MANO fails. + ... Applicability: Notification endpoint is unreachable by the NFV-MANO ... Post-Conditions: none Send Post Request for Subscription with Unreachable callbackUri Check HTTP Response Status Code Is 422 -- GitLab From fc12675f304ac89a0afc572ed152a22c2a7dcc51 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Tue, 19 Oct 2021 11:10:40 +0500 Subject: [PATCH 09/22] comment out unused variabes from CIM API variables.txt file --- .../NFVMANOCimKeywords.robot | 164 +++++++++--------- .../environment/variables.txt | 16 +- 2 files changed, 90 insertions(+), 90 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot index cb1eb6210..9471ad5ab 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot @@ -33,7 +33,7 @@ Check HTTP Response Body Json Schema Is Send Post request for NFV-MANO Entity Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity ${output}= Output response Set Suite Variable ${response} ${output} @@ -41,7 +41,7 @@ Send Post request for NFV-MANO Entity GET NFV-MANO entity resource Log Trying to get a NFV-MANO entity resource Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity ${output}= Output response Set Suite Variable ${response} ${output} @@ -49,7 +49,7 @@ GET NFV-MANO entity resource Send Put request for NFV-MANO Entity Log Trying to perform a PUT (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/log_jobs/mano_entity ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -61,7 +61,7 @@ Send Patch request for NFV-MANO Entity log Trying to modify an NFV-MANO Entity Set Headers {"Accept":"${ACCEPT_JSON}"} Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${body}= Get File jsons/ManoConfigModificationRequest.json Patch ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity ${body} ${outputResponse}= Output response @@ -70,7 +70,7 @@ Send Patch request for NFV-MANO Entity Send Delete request for NFV-MANO Entity Log Trying to perform a DELETE (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity ${output}= Output response Set Suite Variable ${response} ${output} @@ -78,7 +78,7 @@ Send Delete request for NFV-MANO Entity Send Post request for NFV-MANO functional entity application state change Log Trying to perform a POST for NFV-MANO functional entity application state change Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${template}= Get File jsons/ChangeStateRequest.json ${body}= Format String ${template} state=${state} stateAction=${stateAction} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/change_state @@ -90,7 +90,7 @@ Wait for entity state change success notification and validate status Check entity state Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Get ${response['headers']['Location']} Log Validate Status code Integer response status 200 @@ -101,7 +101,7 @@ Check entity state Send Get request for NFV-MANO functional entity application state change Log Trying to perform a GET (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -109,7 +109,7 @@ Send Get request for NFV-MANO functional entity application state change Send Put request for NFV-MANO functional entity application state change Log Trying to perform a PUT (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/log_jobs/mano_entity/change_state ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -120,7 +120,7 @@ Send Put request for NFV-MANO functional entity application state change Send Patch request for NFV-MANO functional entity application state change Log Trying to perform a PATCH (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -128,7 +128,7 @@ Send Patch request for NFV-MANO functional entity application state change Send Delete request for NFV-MANO functional entity application state change Log Trying to perform a DELETE (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -136,7 +136,7 @@ Send Delete request for NFV-MANO functional entity application state change Send Post request for Change State Operation Occurrences Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${output}= Output response Set Suite Variable ${response} ${output} @@ -144,7 +144,7 @@ Send Post request for Change State Operation Occurrences Get Change State Operation Occurrences Log Query to GET information about multiple change state operation occurrences. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${outputResponse}= Output response @@ -152,7 +152,7 @@ Get Change State Operation Occurrences Get Change State Operation Occurrences with invalid filter Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?attribute_not_exist=some_value ${outputResponse}= Output response @@ -160,7 +160,7 @@ Get Change State Operation Occurrences with invalid filter Get Change State Operation Occurrences with invalid selector Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?fields=wrong_field ${outputResponse}= Output response @@ -169,7 +169,7 @@ Get Change State Operation Occurrences with invalid selector Get Change State Operation Occurrences with filter Log Query information about multiple change state operation occurrences with attribute filters. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?${filter}=${filter_value} ${outputResponse}= Output response @@ -178,7 +178,7 @@ Get Change State Operation Occurrences with filter Get Change State Operation Occurrences with all_fields attribute selector Log Queries information about multiple change state operation occurrences, using all_fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?exclude_default ${output}= Output response Set Suite Variable ${response} ${output} @@ -186,7 +186,7 @@ Get Change State Operation Occurrences with all_fields attribute selector Get Change State Operation Occurrences with fields attribute selector Log Queries information about multiple change state operation occurrences, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -194,7 +194,7 @@ Get Change State Operation Occurrences with fields attribute selector Get Change State Operation Occurrences with exclude_default attribute selector Log Queries information about multiple change state operation occurrences, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?exclude_default ${output}= Output response Set Suite Variable ${response} ${output} @@ -202,7 +202,7 @@ Get Change State Operation Occurrences with exclude_default attribute selector Get Change State Operation Occurrences with exclude_fields attribute selector Log Queries information about multiple change state operation occurrences, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?exclude_fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -210,7 +210,7 @@ Get Change State Operation Occurrences with exclude_fields attribute selector Get Change State Operation Occurrences with fields and exclude_default attribute selector Log Queries information about multiple change state operation occurrences, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?exclude_default&fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -222,7 +222,7 @@ Check HTTP Response Header Contains Link Send PUT request for Change State Operation Occurrences log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -230,7 +230,7 @@ Send PUT request for Change State Operation Occurrences Send PATCH request for Change State Operation Occurrences log Trying to perform a PATCH. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Patch ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -238,7 +238,7 @@ Send PATCH request for Change State Operation Occurrences Send DELETE request for Change State Operation Occurrences log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -246,7 +246,7 @@ Send DELETE request for Change State Operation Occurrences Send Post request for Individual Change State Operation Occurrence Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${output}= Output response Set Suite Variable ${response} ${output} @@ -254,7 +254,7 @@ Send Post request for Individual Change State Operation Occurrence Get Individual Change State Operation Occurrence Log Query to GET information about individual change state operation occurrences. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${outputResponse}= Output response @@ -263,7 +263,7 @@ Get Individual Change State Operation Occurrence Send Put request for Individual Change State Operation Occurrence log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -271,7 +271,7 @@ Send Put request for Individual Change State Operation Occurrence Send Patch request for Individual Change State Operation Occurrence log Trying to perform a PATCH. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Patch ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -279,7 +279,7 @@ Send Patch request for Individual Change State Operation Occurrence Send Delete request for Individual Change State Operation Occurrence log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -287,7 +287,7 @@ Send Delete request for Individual Change State Operation Occurrence Send Post request for NFV-MANO Service Interfaces Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${output}= Output response Set Suite Variable ${response} ${output} @@ -295,7 +295,7 @@ Send Post request for NFV-MANO Service Interfaces Get NFV-MANO Service Interfaces Log Query to GET information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${outputResponse}= Output response @@ -303,7 +303,7 @@ Get NFV-MANO Service Interfaces Get NFV-MANO Service Interfaces with invalid filter Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?attribute_not_exist=some_value ${outputResponse}= Output response @@ -311,7 +311,7 @@ Get NFV-MANO Service Interfaces with invalid filter Get NFV-MANO Service Interfaces with invalid selector Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?fields=wrong_field ${outputResponse}= Output response @@ -320,7 +320,7 @@ Get NFV-MANO Service Interfaces with invalid selector Get NFV-MANO Service Interfaces with filter Log Query information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity with attribute filters. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?${filter}=${filter_value} ${outputResponse}= Output response @@ -329,7 +329,7 @@ Get NFV-MANO Service Interfaces with filter Get NFV-MANO Service Interfaces with all_fields attribute selector Log Queries information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, using all_fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?exclude_default ${output}= Output response Set Suite Variable ${response} ${output} @@ -337,7 +337,7 @@ Get NFV-MANO Service Interfaces with all_fields attribute selector Get NFV-MANO Service Interfaces with exclude_default and fields attribute selector Log Queries information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, using all_fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?exclude_default&fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -345,7 +345,7 @@ Get NFV-MANO Service Interfaces with exclude_default and fields attribute select Get NFV-MANO Service Interfaces with fields attribute selector Log Queries information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -353,7 +353,7 @@ Get NFV-MANO Service Interfaces with fields attribute selector Get NFV-MANO Service Interfaces with exclude_fields attribute selector Log Queries information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?exclude_fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -361,7 +361,7 @@ Get NFV-MANO Service Interfaces with exclude_fields attribute selector Send PUT request for NFV-MANO Service Interfaces log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -369,7 +369,7 @@ Send PUT request for NFV-MANO Service Interfaces Send PATCH request for NFV-MANO Service Interfaces log Trying to perform a PATCH. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Patch ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -377,7 +377,7 @@ Send PATCH request for NFV-MANO Service Interfaces Send DELETE request for NFV-MANO Service Interfaces log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -385,14 +385,14 @@ Send DELETE request for NFV-MANO Service Interfaces Send Post request for Individual NFV-MANO Service Interface Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${output}= Output response Set Suite Variable ${response} ${output} Get Individual NFV-MANO Service Interface Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${outputResponse}= Output response @@ -401,7 +401,7 @@ Get Individual NFV-MANO Service Interface Send Put request for Individual NFV-MANO Service Interface log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -410,7 +410,7 @@ Send Patch request for Individual NFV-MANO Service Interface log Trying to modify an NFV-MANO Entity Set Headers {"Accept":"${ACCEPT_JSON}"} Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${body}= Get File jsons/ManoServiceInterfaceModificationRequest.json Patch ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${body} ${outputResponse}= Output response @@ -419,7 +419,7 @@ Send Patch request for Individual NFV-MANO Service Interface Send Delete request for Individual NFV-MANO Service Interface log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -427,7 +427,7 @@ Send Delete request for Individual NFV-MANO Service Interface Send Post request for Change interface state task Log Trying to perform a POST for Change interface state task Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${template}= Get File jsons/ChangeStateRequest.json ${body}= Format String ${template} state=${state} stateAction=${stateAction} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${body} @@ -439,7 +439,7 @@ Check PostCondition NFV-MANO service interface state matches the requested state Check interface state Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Get ${response['headers']['Location']} Log Validate Status code Integer response status 200 @@ -450,7 +450,7 @@ Check interface state Send Get request for Change interface state task Log Trying to perform a GET (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -458,7 +458,7 @@ Send Get request for Change interface state task Send Put request for Change interface state task Log Trying to perform a PUT (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -469,7 +469,7 @@ Send Put request for Change interface state task Send Patch request for Change interface state task Log Trying to perform a PATCH (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -477,7 +477,7 @@ Send Patch request for Change interface state task Send Delete request for Change interface state task Log Trying to perform a DELETE (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}//mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -485,7 +485,7 @@ Send Delete request for Change interface state task Send Post request for Peer Entity Log Trying to perform a POST for Peer Entity Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${template}= Get File jsons/CreatePeerEntityRequest.json ${body}= Format String ${template} peerEntityId=${peerEntityId} name=${name} type=${type} POST ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${body} @@ -495,7 +495,7 @@ Send Post request for Peer Entity Get Peer Entities Log Query to GET information about multiple peer entities. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${outputResponse}= Output response @@ -503,7 +503,7 @@ Get Peer Entities Get Peer Entities with invalid filter Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?attribute_not_exist=some_value ${outputResponse}= Output response @@ -511,7 +511,7 @@ Get Peer Entities with invalid filter Get Peer Entities with invalid selector Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?fields=wrong_field ${outputResponse}= Output response @@ -520,7 +520,7 @@ Get Peer Entities with invalid selector Get Peer Entities with filter Log Query information about multiple peer entities with attribute filters. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?${filter}=${filter_value} ${outputResponse}= Output response @@ -529,7 +529,7 @@ Get Peer Entities with filter Get Peer Entities with all_fields attribute selector Log Queries information about multiple peer entities, using all_fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?exclude_default ${output}= Output response Set Suite Variable ${response} ${output} @@ -537,7 +537,7 @@ Get Peer Entities with all_fields attribute selector Get Peer Entities with fields attribute selector Log Queries information about multiple peer entities, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -545,7 +545,7 @@ Get Peer Entities with fields attribute selector Get Peer Entity with exclude_default and fields attribute selector Log Queries information about multiple peer entities, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?exclude_default&fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -553,7 +553,7 @@ Get Peer Entity with exclude_default and fields attribute selector Get Peer Entities with exclude_fields attribute selector Log Queries information about multiple peer entities, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?exclude_fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -561,7 +561,7 @@ Get Peer Entities with exclude_fields attribute selector Send PUT request for Peer Entities log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -569,7 +569,7 @@ Send PUT request for Peer Entities Send PATCH request for Peer Entities log Trying to perform a PATCH. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Patch ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -577,7 +577,7 @@ Send PATCH request for Peer Entities Send DELETE request for Peer Entities log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -585,14 +585,14 @@ Send DELETE request for Peer Entities Send Post request for Individual Peer Entity Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${output}= Output response Set Suite Variable ${response} ${output} Get Individual Peer Entity Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${outputResponse}= Output response @@ -601,7 +601,7 @@ Get Individual Peer Entity Send Put request for Individual Peer Entity log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -610,7 +610,7 @@ Send Patch request for Individual Peer Entity log Trying to modify an NFV-MANO Entity Set Headers {"Accept":"${ACCEPT_JSON}"} Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${body}= Get File jsons/PeerEntityConfigModificationRequest.json Patch ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${body} ${outputResponse}= Output response @@ -619,7 +619,7 @@ Send Patch request for Individual Peer Entity Send Delete request for Individual Peer Entity log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -705,7 +705,7 @@ Check Postcondition Subscription Is Set Send Post Request for Duplicated Subscription Set headers {"Content-Type": "${CONTENT_TYPE_JSON}"} Set headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${template}= Get File jsons/CimSubscriptionRequest.json ${body_request}= Format String ${template} callback_uri=${callback_uri} callback_endpoint=${callback_endpoint} POST ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${body_request} allow_redirects=false @@ -734,7 +734,7 @@ Check Postcondition Subscription Resource Returned in Location Header Is Availab Send Put Request for Subscriptions [Documentation] This method is not supported. When this method is requested on this resource, the NFV-MANO shall return a "405 Method ... Not Allowed" response as defined in clause 4.3.5.4. - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} PUT ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${output}= Output response Set Suite Variable ${response} ${output} @@ -742,7 +742,7 @@ Send Put Request for Subscriptions Send Patch Request for Subscriptions [Documentation] This method is not supported. When this method is requested on this resource, the NFV-MANO shall return a "405 Method ... Not Allowed" response as defined in clause 4.3.5.4. - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${output}= Output response Set Suite Variable ${response} ${output} @@ -750,14 +750,14 @@ Send Patch Request for Subscriptions Send Delete Request for Subscriptions [Documentation] This method is not supported. When this method is requested on this resource, the NFV-MANO shall return a "405 Method ... Not Allowed" response as defined in clause 4.3.5.4. - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${output}= Output response Set Suite Variable ${response} ${output} Get Individual Subscription Set headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${subscriptionId} ${output}= Output response Set Suite Variable ${response} ${output} @@ -769,14 +769,14 @@ Check HTTP Response Body Subscription Identifier matches the requested Subscript GET individual Subscription with invalid resource identifier Set headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${erroneousSubscriptionId} ${output}= Output response Set Suite Variable ${response} ${output} Send Delete request for individual Subscription Set headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${subscriptionId} ${output}= Output response Set Suite Variable ${response} ${output} @@ -788,19 +788,19 @@ Check Postcondition Subscription is Deleted Send Delete request for individual Subscription with invalid resource identifier Log Trying to delete a subscription in the VNFM with invalid id - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${erroneousSubscriptionId} ${output}= Output response Set Suite Variable @{response} ${output} Send Post request for individual Subscription - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${newSubscriptionId} ${output}= Output response Set Suite Variable @{response} ${output} Send Put request for individual Subscription - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${subscriptionId} ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -809,7 +809,7 @@ Send Put request for individual Subscription Set Suite Variable @{response} ${output} Send Patch request for individual Subscription - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${subscriptionId} ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -833,7 +833,7 @@ GET Peer Entities with malformed authorization token Pass Execution If ${AUTH_USAGE} == 0 Skipping test as NFVO is not supporting authentication Log The GET method queries using invalid token Set Headers {"Accept": "${ACCEPT_JSON}"} - Set Headers {"Authorization": "${BAD_AUTHORIZATION}"} + Set Headers {"${AUTHORIZATION_HEADER}": "${BAD_AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${output}= Output response @@ -852,7 +852,7 @@ GET Peer Entities with expired or revoked authorization token Pass Execution If ${AUTH_USAGE} == 0 Skipping test as it is not supporting authentication Log The GET method queries using invalid token Set Headers {"Accept": "${ACCEPT_JSON}"} - Set Headers {"Authorization": "${NEG_AUTHORIZATION}"} + Set Headers {"${AUTHORIZATION_HEADER}": "${NEG_AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${output}= Output response diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt index b86b897ab..887bff0d9 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt @@ -3,19 +3,19 @@ ${NFVMANOHOST} localhost ${NFVMANO_PORT} 8080 ${NFVMANO_SCHEMA} https -${AUTHORIZATION} Bearer 0b79bab50daca910b000d4f1a2b675d604257e42 -${NEG_AUTHORIZATION} Bearer negativetoken -${WRONG_AUTHORIZATION} Bearer XXXXXWRONGXXXXX -${BAD_AUTHORIZATION} Bear sometoken +${AUTHORIZATION_TOKEN} Bearer 0b79bab50daca910b000d4f1a2b675d604257e42 +${NEG_AUTHORIZATION_TOKEN} Bearer negativetoken +#${WRONG_AUTHORIZATION_TOKEN} Bearer XXXXXWRONGXXXXX +${BAD_AUTHORIZATION_TOKEN} Bear sometoken ${CONTENT_TYPE_JSON} application/json ${ACCEPT_JSON} application/json ${CONTENT_TYPE_PATCH} application/merge-patch+json ${AUTH_USAGE} 1 -${FIELD_USAGE} 1 +#${FIELD_USAGE} 1 ${NFVMANO_CHECKS_NOTIF_ENDPOINT} 1 ## If true, during subscription, the FUT performs a get to the notification endpoint -${NFVMANO_ALLOWS_DUPLICATE_SUBS} 1 +#${NFVMANO_ALLOWS_DUPLICATE_SUBS} 1 ${apiRoot} / ${apiMajorVersion} v2 @@ -41,8 +41,8 @@ ${callback_endpoint} /subscriptions ${filter_ok} callbackUri=${callbackUri} ${filter_ko} erroneousFilter=erroneous ${callback_endpoint_fwd} /endpoint/check -${callback_endpoint_error} /subs_404 -${sleep_interval} 20s +#${callback_endpoint_error} /subs_404 +#${sleep_interval} 20s ${total_polling_time} 2 min ${polling_interval} 10 sec -- GitLab From bbdbdbb84aa12c8807e22c89a11547e9bb1d02aa Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Tue, 19 Oct 2021 11:15:21 +0500 Subject: [PATCH 10/22] removed unused OpenAPI yaml --- .../NFVMANOCimKeywords.robot | 1 + ...onfigurationInformationManagement-API.yaml | 33445 ---------------- .../Subscriptions.robot | 4 +- 3 files changed, 3 insertions(+), 33447 deletions(-) delete mode 100644 SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot index 9471ad5ab..c77617894 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot @@ -676,6 +676,7 @@ Send Post Request for Subscription ... Check Notification Endpoint Send Post Request for Subscription with Unreachable callbackUri + Log Trying to create a subscription for an unreachable Notification Endpoint Set headers {"Content-Type": "${CONTENT_TYPE_JSON}"} Set headers {"Accept": "${ACCEPT_JSON}"} Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": ${AUTHORIZATION}"} diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml b/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml deleted file mode 100644 index 3fed77a90..000000000 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml +++ /dev/null @@ -1,33445 +0,0 @@ -openapi: 3.0.2 -info: - version: '1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1' - title: SOL009 - NFV-MANO Configuration and Information Management Interface - description: > - SOL009 - NFV-MANO Configuration and Information 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' - contact: - name: NFV-SOL WG -externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: >- - https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf -servers: - - url: 'http://0.0.0.0/nfvmanocim/v1' - description: | - API HTTP Server - - url: 'https://0.0.0.0/nfvmanocim/v1' - description: | - API HTTPS Server -paths: - /api_versions: - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: false - schema: - type: string - - name: Authorization - description: 'The authorization token for the request. Reference: IETF RFC 7235' - in: header - required: false - schema: - type: string - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow - the provisions specified in table 4.6.3.3.3.2-1 for request and response - data structures, and response codes. URI query parameters are not - supported. - responses: - '200': - description: > - 200 OK - - API version information was read successfully. The response body - shall contain 4.4 API version information, as defined in clause - 4.4.1.13. - content: - application/json: - schema: - description: | - This type represents API version information. - type: object - required: - - uriPrefix - - apiVersions - properties: - uriPrefix: - description: > - Specifies the URI prefix for the API, in the following - form {apiRoot}/{apiName}/{apiMajorVersion}/. - type: string - apiVersions: - description: > - Version(s) supported for the API signaled by the uriPrefix - attribute. - type: array - items: - type: object - required: - - version - properties: - version: - description: > - Identifies a supported version. The value of the - version attribute shall be a version identifier as - specified in clause 9.1 (SOL013). - type: string - isDeprecated: - description: > - If such information is available, this attribute - indicates whether use of the version signaled by the - version attribute is deprecated (true) or not - (false). - - A deprecated version is still supported by the API - producer but is recommended not to be used any - longer. When a version is no longer supported, it - does not appear in the response body. - type: boolean - retirementDate: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - schema: - type: string - maximum: 1 - minimum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '413': - description: > - 413 PAYLOAD TOO LARGE - - If the payload body of a request is larger than the amount of data - the API producer is willing or able to process, it shall respond - with this response code, following the provisions in IETF RFC 7231 - for the use of the "Retry-After" HTTP header and for closing the - connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '414': - description: > - 414 URI TOO LONG - - If the request URI of a request is longer than the API producer is - willing or able to process, it shall respond with this response - code. This condition can e.g. be caused by passing long queries in - the request URI of a GET request. The "ProblemDetails" structure may - be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '416': - description: | - 416 Range Not Satisfiable - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '429': - description: > - 429 TOO MANY REQUESTS - - If the API consumer has sent too many requests in a defined period - of time and the API producer is able to detect that condition ("rate - limiting"), the API producer shall respond with this response code, - following the provisions in IETF RFC 6585 [17] for the use of the - "Retry-After" HTTP header. The "ProblemDetails" structure shall be - provided and shall include in the "detail" attribute more - information about the source of the problem. - - The period of time and allowed number of requests are configured - within the API producer by means outside the scope of the present - document. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity: - get: - description: > - Retrives information about an NFV-MANO functional entity by reading the - NFV-MANO entity resource. This method shall follow the provisions - specified in the tables 5.5.3.3.2-1 and 5.5.3.3.2-2 for URI query - parameters, request and response data structures, and response - codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when configuration and information about the - NFV-MANO functional entity has been read successfully. The response - body shall contain a representation of the NFV-MANO functional - entity, as defined in clause 5.6.2.2. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: > - Human-readable description of the NFV-MANO functional - entity. - - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional - entity. It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional - entity. $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component - realizing part of an NFV-MANO functional entity. It is - optional for the API producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on - the NFV-MANO functional entity component. The - identifier of the ManoService is referred. A - service may depend on multiple components. Multiple - services may depend on the same component. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the - NFV-MANO functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO - service provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO service. - - This attribute can be modified with the PATCH - method. - type: string - description: - description: > - Human-readable description of the NFV-MANO service. - - This attribute can be modified with the PATCH - method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service - interface" resources with information about the - associated interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource - using an absolute URI. - type: object - required: - - href - properties: - href: - description: > - String formatted according to IETF RFC - 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional - entity’s application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an - NFVO entity, and that can be relevant to more than one - NFV-MANO service offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of - this parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded - on the NFVO. - - NOTE: If this attribute is not present, the value of - this parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a - VNFM entity, and that can be relevant to more than one - NFV-MANO service offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. - to determine the compatibility of a VNF with certain - VNFM according to the vnfmInfo attribute in the VNFD - (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a - VIM entity, and that can be relevant to more than one - NFV-MANO service offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies the NFV-MANO entity resource. Changes to the various - configuration and information attributes are applied to the NFV-MANO - functional entity, and are reflected in the representation of this - resource. This method shall follow the provisions specified in the - tables 5.5.3.3.4-1 and 5.5.3.3.4-2 for URI query parameters, request - and response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the NFV-MANO configuration and information - modification, as defined in clause 5.6.2.3. The Content-Type header - shall be set to "application/merge-patch+json" according to IETF RFC - 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute - array in the "ManoEntityConfigurableParams", as defined - below this table. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case - of an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the - "clockSyncs" attribute array in the - "ManoEntityConfigurableParams", as defined below this - table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" - attribute array in the "ManoEntity", as defined below this - table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the modification of configuration on the - NFV-MANO functional entity has been accepted and completed. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on the "NFV-MANO entity" resource of the producer - NFV-MANO functional entity. The attributes that can be - included consist of those requested to be modified explicitly - in the "ManoConfigModificationRequest" data structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoEntity", as defined in clause - 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in - clause 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", - as defined in clause 5.6.2.3. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock - synchronization. Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case - of an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 - address, string that consists of groups of zero - to four hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as - an object. It shall comply with the provisions - defined in clause 4 of IETF RFC 8259. In the - following example, a list of key-value pairs with - four keys ("aString", "aNumber", "anArray" and - "anObject") is provided to illustrate that the - values associated with different keys can be of - different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of - certain entries in "clockSyncs" attribute in - "ManoEntityConfigurableParams", as defined in clause - 5.6.2.3. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as - defined in clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - name: - description: > - If present, this attribute signals modification of - the "name" attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of - the "description" attribute in the "ManoService". - type: string - required: - - id - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "NFV-MANO entity" resource. - - Typically, this is due to the fact that another configuration and - information modification is ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity/change_state: - post: - description: > - Requests to change the state of the NFV-MANO functional entity - application. - - This method shall follow the provisions specified in the tables - 5.5.7.3.1-1 and 5.5.7.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state - of a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - responses: - '202': - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "Individual change state - operation occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the - error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity/mano_interfaces: - get: - description: > - Queries information about multiple NFV-MANO service interfaces of the - NFV-MANO functional entity. This method shall follow the provisions - specified in the tables 5.5.10.3.2-1 and 5.5.10.3.2-2 for URI query - parameters, request and response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the ManoServiceInterface and in - data types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ManoServiceInterface structure in the response body if this - parameter is provided, or none of the parameters "all_fields," - "fields", "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about zero or more NFV-MANO - service interfaces has been queried successfully. - - The response body shall contain in an array the representations of - zero or more NFV-MANO service interfaces, as defined in clause - 5.6.2.11. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents an individual NFV-MANO service - interface produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: > - Information about supported operations of this - interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing - the SSL or TLS negotiation with the API client. - Valid values of cipher suites are defined in - IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/mano_entity/mano_interfaces/{manoServiceInterfaceId}': - parameters: - - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - retrieves information about an NFV-MANO service interface of the - producer NFV-MANO functional entity by reading an "Individual NFV-MANO - service interface" resource. - - This method shall follow the provisions specified in the tables - 5.5.11.3.2-1 and 5.5.11.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual NFV-MANO - service interface has been read successfully. - - The response body shall contain a representation of the NFV-MANO - service interface, as defined in clause 5.6.2.11. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant to - (see also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall - be present for ETSI NFV specified RESTful NFV-MANO - APIs. The major version is defined in the standard - the interface is compliant to (see also clause 4.1 of - ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It - shall comply with the provisions defined in clause 4 of - IETF RFC 8259. In the following example, a list of - key-value pairs with four keys ("aString", "aNumber", - "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of - different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies an "Individual NFV-MANO service interface" resource. - - Changes to the configurable parameters of the corresponding NFV-MANO - service interface are applied to the information managed by the - producer NFV-MANO functional entity and reflected in the representation - of this resource. - - This method shall follow the provisions specified in the tables - 5.5.11.3.4-1 and 5.5.11.3.4-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the modification of configuration parameters of the - NFV-MANO service interface, as defined in clause 5.6.2.12. - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer - NFV-MANO functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual NFV-MANO service interface" - resource, as defined in clause 5.6.2.13. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on an Individual NFV-MANO service interface" - resource. The attributes that can be included consist of - those requested to be modified explicitly in the - "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the - "ManoServiceInterface" data structure that were modified - implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoServiceInterface", as defined in - clause 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It - shall comply with the provisions defined in clause 4 of - IETF RFC 8259. In the following example, a list of - key-value pairs with four keys ("aString", "aNumber", - "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of - different type. - type: object - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual NFV-MANO service interface" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/mano_entity/mano_interfaces/{manoServiceInterfaceId}/change_state': - parameters: - - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - post: - description: > - Requests to change the state of the NFV-MANO service interface produced - by the NFV-MANO functional entity. - - This method shall follow the provisions specified in the tables - 5.5.12.3.1-1 and 5.5.12.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state - of a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - responses: - '202': - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for - processing. - - The response body shall be empty. - - The HTTP response shall include a “Location” HTTP header that - contains the URI of the newly-created "Individual change state - operation occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the - error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /subscriptions: - post: - description: > - Creates a new subscription. - - This method shall follow the provisions specified in the tables - 5.5.4.3.1-1 and 5.5.4.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Details of the subscription to be created, as defined in clause - 5.6.2.5-1. - content: - application/json: - schema: - description: > - This type represents a subscription request related to - notifications about NFV-MANO configuration and information - management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their associated - managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference to - NFV-MANO services in a filter. They should not be - used together in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed in - this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed in - this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization - which 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The clientId and - clientPassword passed in a subscription shall not be - the same as the clientId and clientPassword that are - used to obtain authorization for API requests. - Client credentials may differ between subscriptions. - The value of clientPassword should be generated by a - random process. - 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. The clientId and - clientPassword passed in a subscription shall not be - the same as the clientId and clientPassword that are - used to obtain authorization for API requests. - Client credentials may differ between subscriptions. - The value of clientPassword should be generated by a - random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when the subscription has been created - successfully. - - The response body shall contain a representation of the created - "Individual subscription" resource. - - The HTTP response shall include a "Location" HTTP header that - points to the created "Individual subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual subscription" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference - to NFV-MANO services in a filter. They should not - be used together in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed - in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed - in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '303': - description: > - 303 SEE OTHER - - SShall be returned when a subscription with the same callbackURI - and the same filter already exists and the policy of NFV-MANO - functional entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that - contains the resource URI of the existing "Individual subscription" - resource. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual subscription" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: > - queries the list of active subscriptions of the API consumer that - invokes the method. It can be used, e.g., for resynchronization after - error situations. - - This method shall follow the provisions specified in the tables - 5.5.4.3.2-1 and 5.5.4.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the CimSubscription and in data - types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations of - all active subscriptions of the functional block that invokes the - method, i.e., zero or more representations of NFV-MANO - configuration and information management subscriptions as defined - in clause 5.6.2.6. - - If the "filter" URI parameter was supplied in the request, the data - in the response body shall have been transformed according to the - rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being - globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the - respective type within a NFV-MANO functional - entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to - reference to NFV-MANO services in a filter. They - should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity - produced interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the - respective type within a NFV-MANO functional - entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity - produced interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives - to reference to NFV-MANO functional entity - consumed interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives - to reference to NFV-MANO functional entity - consumed interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/subscriptions/{subscriptionId}': - parameters: - - name: subscriptionId - in: path - description: Identifier of the subscription - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - Retrieves information about a subscription by reading an "Individual - subscription" resource. - - This method shall follow the provisions specified in the tables - 5.5.5.3.2-1 and 5.5.5.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual subscription - has been read successfully. - - The response body shall contain a representation of the "Individual - subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference - to NFV-MANO services in a filter. They should not - be used together in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed - in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed - in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: > - Terminates an individual subscription. - - This method shall follow the provisions specified in the tables - 5.5.5.3.5-1 and 5.5.5.3.5-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has - been deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /change_state_ops: - get: - description: > - The API consumer can use the GET method to query status information - about multiple change state operation occurrences. - - This method shall follow the provisions specified in the tables - 5.5.8.3.2-1 and 5.5.8.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the ChangeStateOpOcc and in data - types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ChangeStateOpOcc structure in the response body if this parameter - is provided, or none of the parameters "all_fields," "fields", - "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when status information for zero or more "change - state operation occurrences" has been queried successfully. - - The response body shall contain in an array the status information - about zero or more "Individual change state operation occurrences", - as defined in clause 5.6.2.9. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a - managed object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted - values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request - data type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual - resource, and may be present according to the chosen - attribute selector parameter if this data type is - returned in a response to a query of a container - resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/change_state_ops/{changeStateOpOccId}': - parameters: - - name: changeStateOpOccId - in: path - description: Identifier of the change state operation occurrence - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - The API consumer can use the GET method to retrieve status information - about a change state operation occurrence by reading an "Individual - change state operation occurrence" resource. - - This method shall follow the provisions specified in the tables - 5.5.9.3.2-1 and 5.5.9.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an "Individual change - state operation occurrence" resource has been read successfully. - - The response body shall contain status information about a change - state operation occurrence, as defined in clause 5.6.2.9. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted - values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request - data type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual resource, - and may be present according to the chosen attribute - selector parameter if this data type is returned in a - response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /peer_entities: - post: - description: > - Creates in the producer NFV-MANO functional entity a new peer entity - resource which contains configuration and information with regards to - the peer functional entity. - - This method shall follow the provisions specified in the tables - 5.5.13.3.1-1 and 5.5.13.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: | - The peer entity creation parameters, as defined in clause 5.6.2.14. - content: - application/json: - schema: - description: > - This type represents request parameters for the creation of a - new peer entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when a new "Individual peer entity" resource has - been created successfully. - - The response body shall contain a representation of the created - resource with regards to a peer entity, as defined in clause - 5.6.2.15. - - The HTTP response shall include a “Location” HTTP header that - points to the created "Individual peer entity" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual peer entity" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: > - Queries information and configuration in the producer NFV-MANO - functional entity with regards to multiple peer entities. - - This method shall follow the provisions specified in the tables - 5.5.13.3.2-1 and 5.5.13.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the PeerEntity and in data types - referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the PeerEntity - structure in the response body if this parameter is provided, or - none of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about zero or more peer entities - has been queried successfully. - - The response body shall contain in an array the resource - representations of zero or more peer entities, as defined in clause - 5.6.2.15. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - peerEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: > - Human-readable description of the peer functional - entity. - - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the - API. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The major version is - defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used - by the API consumer accessing the API. - - The support of authorization methods for the - API consumer is specified in clause 8.3.6 of - ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC - 5246. - OAUTH2: Using access token, as defined - by the OAuth 2.0 specification in IETF RFC - 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be - declared as supported by the API consumer - when performing the SSL or TLS - negotiation with the authorization server. - Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the - use of TLS tunnel. Shall be present if - authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be - declared as supported by the API consumer - when performing the SSL or TLS negotiation - with the API producer. Valid values of - cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the - API consumer when creating the resource or when - updating it with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/peer_entities/{peerEntityId}': - parameters: - - name: peerEntityId - in: path - description: Identifier of the peer entity - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - Retrieves information and configuration hold in the producer NFV-MANO - functional entity with regards to a peer entity by reading an - individual peer entity resource. - - This method shall follow the provisions specified in the tables - 5.5.14.3.2-1 and 5.5.14.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual peer - functional entity has been read successfully. - - The response body shall contain a resource representation of the - peer functional entity, as defined in clause 5.6.2.15. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies configuration and information of the producer NFV-MANO - functional entity with regards to a peer functional entity by updating - the corresponding "Individual peer entity" resource. - - Changes to the configurable parameters of the corresponding peer entity - are applied to the information managed by the producer NFV-MANO - functional entity and reflected in the representation of this resource. - - This method shall follow the provisions specified in the tables - 5.5.14.3.4-1 and 5.5.14.3.4-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the modification of configuration parameters of the - peer functional entity, as defined in clause 5.6.2.16 - - The Content-Type header shall be set to - "application/merge-patch+json" according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or - "null" to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " - PeerEntity ", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual peer entity" resource, as defined - in clause 5.6.2.17. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on an "Individual peer entity" resource. The - attributes that can be included consist of those requested to - be modified explicitly in the - "PeerEntityConfigModificationRequest" data structure. If - applicable, additional attributes of the "PeerEntity" data - structure that were modified implicitly shall also be - provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in - clause 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of - certain entries in the "consumedManoInterfaces" attribute - in "PeerEntity", as defined in clause 5.6.2.15. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual peer entity" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: > - Ddeletes an individual peer entity resource. By deleting such a - resource in the producer NFV-MANO functional entity representing a peer - NFV-MANO entity, the configuration and information with regards to such - peer entity is deleted. Consequently, the peering relationship between - the producer NFV-MANO functional entity and the peer entity is - terminated, i.e., the producer NFV-MANO functional entity does not have - the necessary information to communicate/interact with the peer entity. - - This method shall follow the provisions specified in the tables - 5.5.14.3.5-1 and 5.5.14.3.5-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: > - 204 NO CONTENT - - Shall be returned when the "Individual peer entity" resource has - been deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual peer entity" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 -components: - schemas: - ManoEntity: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional entity. - It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional entity. $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component realizing - part of an NFV-MANO functional entity. It is optional for the API - producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the - NFV-MANO functional entity component. The identifier of the - ManoService is referred. A service may depend on multiple - components. Multiple services may depend on the same - component. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the NFV-MANO - functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO service - provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" - resources with information about the associated - interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional entity’s - application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an NFVO - entity, and that can be relevant to more than one NFV-MANO service - offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM - entity, and that can be relevant to more than one NFV-MANO service - offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to - determine the compatibility of a VNF with certain VNFM - according to the vnfmInfo attribute in the VNFD (see table - 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a VIM - entity, and that can be relevant to more than one NFV-MANO service - offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - ManoConfigModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute array - in the "ManoEntityConfigurableParams", as defined below this - table. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the "clockSyncs" - attribute array in the "ManoEntityConfigurableParams", as defined - below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" attribute - array in the "ManoEntity", as defined below this table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - ManoConfigModifications: - description: > - This type represents attribute modifications that were performed on the - "NFV-MANO entity" resource of the producer NFV-MANO functional entity. - The attributes that can be included consist of those requested to be - modified explicitly in the "ManoConfigModificationRequest" data - structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoEntity", as defined in clause 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in clause - 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of certain entries - in "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as defined in - clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - If present, this attribute signals modification of the "name" - attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of the - "description" attribute in the "ManoService". - type: string - required: - - id - CimSubscriptionRequest: - description: > - This type represents a subscription request related to notifications - about NFV-MANO configuration and information management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The - clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are - used to obtain authorization for API requests. Client - credentials may differ between subscriptions. The value of - clientPassword should be generated by a random process. - 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. The - clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are - used to obtain authorization for API requests. Client - credentials may differ between subscriptions. The value of - clientPassword should be generated by a random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - CimSubscription: - description: > - This type represents a subscription related to notifications about - NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - ChangeStateRequest: - description: > - This type represents request parameters for changing the state of a - managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - ChangeStateOpOcc: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according to IETF - RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according to IETF - RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed object of - a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if attribute - "manoEntityComponents" in "ManoEntity" is supported by the API - producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: | - An identifier with the intention of being globally unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This attribute shall - be formatted according to the request data type of the related - change state operation. - - The following mapping between operationType and the data type of - this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is returned in a - response to reading an individual resource, and may be present - according to the chosen attribute selector parameter if this data - type is returned in a response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - ManoServiceInterface: - description: > - This type represents an individual NFV-MANO service interface produced - by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO functional entity interface. - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the NFV-MANO - functional entity. Valid values are defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - {apiName} of each interface is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be present - for ETSI NFV specified RESTful NFV-MANO APIs. The major version - is defined in the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - ManoServiceInterfaceModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer NFV-MANO - functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - ManoServiceInterfaceModifications: - description: > - This type represents attribute modifications that were performed on an - Individual NFV-MANO service interface" resource. The attributes that - can be included consist of those requested to be modified explicitly in - the "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the "ManoServiceInterface" data - structure that were modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - CreatePeerEntityRequest: - description: > - This type represents request parameters for the creation of a new peer - entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO functional - entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - PeerEntity: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO functional - entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API consumer - when creating the resource or when updating it with the PATCH - method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - PeerEntityConfigModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or "null" - to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " PeerEntity ", as - defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - PeerEntityConfigModifications: - description: > - This type represents attribute modifications that were performed on an - "Individual peer entity" resource. The attributes that can be included - consist of those requested to be modified explicitly in the - "PeerEntityConfigModificationRequest" data structure. If applicable, - additional attributes of the "PeerEntity" data structure that were - modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "PeerEntity", as defined in clause 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of certain entries - in the "consumedManoInterfaces" attribute in "PeerEntity", as - defined in clause 5.6.2.15. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - ManoConfigurableParams: - description: | - # Warning: No definition found in the document ManoConfigurableParams - ManoEntityComponent: - description: > - This type represents information of a deployed component realizing part - of an NFV-MANO functional entity. It is optional for the API producer - to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the NFV-MANO - functional entity component. The identifier of the ManoService is - referred. A service may depend on multiple components. Multiple - services may depend on the same component. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - required: - - id - ManoService: - description: > - This type represents information about an NFV-MANO service provided by - the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" resources - with information about the associated interfaces to the - NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an absolute - URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - NfvoSpecificInfo: - description: > - This type represents information attributes specific to an NFVO entity, - and that can be relevant to more than one NFV-MANO service offered by - an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - VnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM entity, - and that can be relevant to more than one NFV-MANO service offered by a - VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to determine - the compatibility of a VNF with certain VNFM according to the - vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS - NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - VimSpecificInfo: - description: > - This type represents information attributes specific to a VIM entity, - and that can be relevant to more than one NFV-MANO service offered by a - VIM entity. - type: object - ManoEntityConfigurableParams: - description: > - This type represents list of parameters that can be configured on the - NFV MANO functional entity. - type: object - properties: - clockSyncs: - description: >- - Properties of the clock synchronization to be used by the NFV-MANO - functional entity. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - minItems: 1 - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - required: - - clockSyncs - - defaultLogCompileBySizeValue - - defaultLogCompileByTimerValue - ConsumedManoInterfaceInfo: - description: > - This type represents an interface consumed by the producer NFV MANO - functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the NFV-MANO - functional entity. Valid values are defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and path - where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - {apiName} of each interface is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be present - for ETSI NFV specified RESTful NFV-MANO APIs. The major version - is defined in the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for accessing an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API consumer - accessing the API. - - The support of authorization methods for the API consumer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by - TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as - defined by the OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When used, - the request to the WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI GS - NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API consumer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API consumer when performing the SSL or TLS negotiation - with the API producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - CimNotificationsFilter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match NFV-MANO - functional entities and their associated managed objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced interfaces - with an instance identifier listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference to - NFV-MANO functional entity produced interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced interfaces - with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference to - NFV-MANO functional entity produced interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed interfaces - with an instance identifier listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference to - NFV-MANO functional entity consumed interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed interfaces - with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference to - NFV-MANO functional entity consumed interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - ClockSyncInfo: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an IPV4 - address, string that consists of four decimal integers separated - by dots, each integer ranging from 0 to 255. In case of an IPV6 - address, string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - required: - - id - - type - ServerInterfaceSecurityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by the - API producer when performing the SSL or TLS negotiation with the - API client. Valid values of cipher suites are defined in IETF - RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - ClientInterfaceSecurityInfo: - description: > - This type represents security related information for accessing an - NFV-MANO service interface produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API consumer - accessing the API. - - The support of authorization methods for the API consumer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS - 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by - the OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When used, the - request to the WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI GS - NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by the - API consumer when performing the SSL or TLS negotiation with - the authorization server. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as supported by the - API consumer when performing the SSL or TLS negotiation with - the API producer. Valid values of cipher suites are defined in - IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - ManoServiceInterfaceTypeShortName: - description: "For the RESTful NFV-MANO APIs, valid values are all values for \"apiName\" as defined in ETSI GS NFV-SOL 002, ETSI GS NFV-SOL 003, and ETSI GS NFV-SOL 005.\nFor the NFV-MANO service interfaces for which no API is specified by ETSI NFV, valid values are defined in table 5.6.4.3-1.\nNOTE:\tThe table is expected to be updated, by removing the corresponding listed entries, once the interfaces are specified as a RESTful NFV-MANO API. \n" - type: string - UsageStateEnumType: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - ChangeOperationalStateEnumType: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - ChangeAdministrativeStateEnumType: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - InterfaceOperationalStateEnumType: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - StopEnumType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - ManoEntityEnumType: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - PeerEntityEnumType: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - parameters: - filter.ManoServiceInterface: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the ManoServiceInterface and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.CimSubscription: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the CimSubscription and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.ChangeStateOpOcc: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the ChangeStateOpOcc and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.PeerEntity: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the PeerEntity and in data types - referenced from it shall be supported by the NFV-MANO functional entity - in the expression. - in: query - required: false - schema: - type: string - exclude_default.ManoServiceInterface: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ManoServiceInterface structure in the response body if this parameter - is provided, or none of the parameters "all_fields," "fields", - "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.CimSubscription: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the CimSubscription - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.ChangeStateOpOcc: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the ChangeStateOpOcc - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.PeerEntity: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the PeerEntity - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - manoServiceInterfaceId: - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - subscriptionId: - name: subscriptionId - in: path - description: Identifier of the subscription - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - changeStateOpOccId: - name: changeStateOpOccId - in: path - description: Identifier of the change state operation occurrence - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - name: peerEntityId - in: path - description: Identifier of the peer entity - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - requestBodies: - ModifyManoEntityRequest: - description: > - Parameters for the NFV-MANO configuration and information modification, - as defined in clause 5.6.2.3. The Content-Type header shall be set to - "application/merge-patch+json" according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute - array in the "ManoEntityConfigurableParams", as defined below - this table. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of - an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the - "clockSyncs" attribute array in the - "ManoEntityConfigurableParams", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" attribute - array in the "ManoEntity", as defined below this table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - required: true - ChangeManoEntityStateRequest: - description: | - Parameters for the change state operation, as defined in clause 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state of - a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - ModifyManoEnityInterfaceRequest: - description: > - Parameters for the modification of configuration parameters of the - NFV-MANO service interface, as defined in clause 5.6.2.12. - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer - NFV-MANO functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: true - ChangeManoEntityInterfaceStateRequest: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state of - a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - CimSubscriptionRequest: - description: > - Details of the subscription to be created, as defined in clause - 5.6.2.5-1. - content: - application/json: - schema: - description: > - This type represents a subscription request related to - notifications about NFV-MANO configuration and information - management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which - 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The clientId and clientPassword passed in - a subscription shall not be the same as the clientId - and clientPassword that are used to obtain - authorization for API requests. Client credentials may - differ between subscriptions. The value of - clientPassword should be generated by a random - process. - 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. - The clientId and clientPassword passed in a - subscription shall not be the same as the clientId and - clientPassword that are used to obtain authorization - for API requests. Client credentials may differ - between subscriptions. The value of clientPassword - should be generated by a random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - required: true - CreatePeerEntityRequest: - description: | - The peer entity creation parameters, as defined in clause 5.6.2.14. - content: - application/json: - schema: - description: > - This type represents request parameters for the creation of a new - peer entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - required: true - ModifyPeerEntityRequest: - description: > - Parameters for the modification of configuration parameters of the peer - functional entity, as defined in clause 5.6.2.16 - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or - "null" to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " PeerEntity - ", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: true - responses: - mano_entity.get.200: - description: > - 200 OK - - Shall be returned when configuration and information about the NFV-MANO - functional entity has been read successfully. The response body shall - contain a representation of the NFV-MANO functional entity, as defined - in clause 5.6.2.2. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional - entity. It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional entity. - $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component - realizing part of an NFV-MANO functional entity. It is - optional for the API producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the - NFV-MANO functional entity component. The identifier of - the ManoService is referred. A service may depend on - multiple components. Multiple services may depend on the - same component. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the - NFV-MANO functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO service - provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" - resources with information about the associated - interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional - entity’s application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an - NFVO entity, and that can be relevant to more than one - NFV-MANO service offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on - the NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM - entity, and that can be relevant to more than one NFV-MANO - service offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to - determine the compatibility of a VNF with certain VNFM - according to the vnfmInfo attribute in the VNFD (see - table 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a VIM - entity, and that can be relevant to more than one NFV-MANO - service offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - mano_entity.patch.200: - description: > - 200 OK - - Shall be returned when the modification of configuration on the - NFV-MANO functional entity has been accepted and completed. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on the "NFV-MANO entity" resource of the producer NFV-MANO - functional entity. The attributes that can be included consist of - those requested to be modified explicitly in the - "ManoConfigModificationRequest" data structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoEntity", as defined in clause - 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in clause - 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of - an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of certain - entries in "clockSyncs" attribute in - "ManoEntityConfigurableParams", as defined in clause 5.6.2.3. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as - defined in clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: > - If present, this attribute signals modification of the - "name" attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of the - "description" attribute in the "ManoService". - type: string - required: - - id - mano_entity.patch.409: - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "NFV-MANO - entity" resource. - - Typically, this is due to the fact that another configuration and - information modification is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-change_state.post.202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a "Location" HTTP header that contains - the URI of the newly-created "Individual change state operation - occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - mano_entity-change_state.post.409: - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interfaces.get.200: - description: > - 200 OK - - Shall be returned when information about zero or more NFV-MANO service - interfaces has been queried successfully. - - The response body shall contain in an array the representations of zero - or more NFV-MANO service interfaces, as defined in clause 5.6.2.11. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant to - (see also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. - The major version is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI - GS NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - mano_entity-mano_interfaces.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface.get.200: - description: > - 200 OK - - Shall be returned when information about an individual NFV-MANO service - interface has been read successfully. - - The response body shall contain a representation of the NFV-MANO - service interface, as defined in clause 5.6.2.11. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - mano_entity-mano_interface.patch.200: - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual NFV-MANO service interface" resource, - as defined in clause 5.6.2.13. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on an Individual NFV-MANO service interface" resource. The - attributes that can be included consist of those requested to be - modified explicitly in the - "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the "ManoServiceInterface" - data structure that were modified implicitly shall also be - provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoServiceInterface", as defined in clause - 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - mano_entity-mano_interface.patch.409: - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - NFV-MANO service interface" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface-change_state.post.202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a “Location” HTTP header that contains - the URI of the newly-created "Individual change state operation - occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - mano_entity-mano_interface-change_state.post.409: - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - subscriptions.post.201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - - The response body shall contain a representation of the created - "Individual subscription" resource. - - The HTTP response shall include a "Location" HTTP header that points to - the created "Individual subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual subscription" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscriptions.post.303: - description: > - 303 SEE OTHER - - SShall be returned when a subscription with the same callbackURI and - the same filter already exists and the policy of NFV-MANO functional - entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the existing "Individual subscription" resource. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual subscription" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - subscriptions.get.200: - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations of all - active subscriptions of the functional block that invokes the method, - i.e., zero or more representations of NFV-MANO configuration and - information management subscriptions as defined in clause 5.6.2.6. - - If the "filter" URI parameter was supplied in the request, the data in - the response body shall have been transformed according to the rules - specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their associated - managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference to - NFV-MANO services in a filter. They should not be - used together in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed in - this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed in - this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscriptions.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - subscription.get.200: - description: > - 200 OK - - Shall be returned when information about an individual subscription has - been read successfully. - - The response body shall contain a representation of the "Individual - subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscription.delete.204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has been - deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - change_state_ops.get.200: - description: > - 200 OK - - Shall be returned when status information for zero or more "change - state operation occurrences" has been queried successfully. - - The response body shall contain in an array the status information - about zero or more "Individual change state operation occurrences", as - defined in clause 5.6.2.9. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according - to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according - to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request data - type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual resource, - and may be present according to the chosen attribute - selector parameter if this data type is returned in a - response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - change_state_ops.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - change_state_op.get.200: - description: > - 200 OK - - Shall be returned when information about an "Individual change state - operation occurrence" resource has been read successfully. - - The response body shall contain status information about a change state - operation occurrence, as defined in clause 5.6.2.9. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: | - An identifier with the intention of being globally unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This attribute - shall be formatted according to the request data type of the - related change state operation. - - The following mapping between operationType and the data type - of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is returned - in a response to reading an individual resource, and may be - present according to the chosen attribute selector parameter - if this data type is returned in a response to a query of a - container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - peer_entities.post.201: - description: > - 201 CREATED - - Shall be returned when a new "Individual peer entity" resource has been - created successfully. - - The response body shall contain a representation of the created - resource with regards to a peer entity, as defined in clause 5.6.2.15. - - The HTTP response shall include a “Location” HTTP header that points to - the created "Individual peer entity" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual peer entity" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it with - the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entities.get.200: - description: > - 200 OK - - Shall be returned when information about zero or more peer entities has - been queried successfully. - - The response body shall contain in an array the resource - representations of zero or more peer entities, as defined in clause - 5.6.2.15. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entities.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.get.200: - description: > - 200 OK - - Shall be returned when information about an individual peer functional - entity has been read successfully. - - The response body shall contain a resource representation of the peer - functional entity, as defined in clause 5.6.2.15. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it with - the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entitie.patch.200: - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual peer entity" resource, as defined in - clause 5.6.2.17. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on an "Individual peer entity" resource. The attributes that can - be included consist of those requested to be modified explicitly - in the "PeerEntityConfigModificationRequest" data structure. If - applicable, additional attributes of the "PeerEntity" data - structure that were modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "PeerEntity", as defined in clause 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of certain - entries in the "consumedManoInterfaces" attribute in - "PeerEntity", as defined in clause 5.6.2.15. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - peer_entitie.patch.409: - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - peer entity" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.delete.204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual peer entity" resource has been - deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - peer_entitie.delete.409: - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - peer entity" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.delete.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 3680ae513..2fe757dd3 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -176,11 +176,11 @@ DELETE Subscriptions - Method not implemented POST Create a new subscription - Unprocessable Entity [Documentation] Test ID: 8.3.1.10.13 ... Test title: POST Create a new Subscription - Unprocessable Entity - ... Test objective: The objective is to test that for a POST request for a new subscription, if the test by NFV-MANO for notification endpoint fails, then error 422 will be returned. + ... Test objective: The objective is to test that a new subscription is not created if the notification endpoint is unreachable by the NFV-MANO. ... Pre-conditions: none ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO - ... Applicability: Notification endpoint test by NFV-MANO fails. + ... Applicability: Notification endpoint is unreachable by the NFV-MANO ... Post-Conditions: none Send Post Request for Subscription with Unreachable callbackUri Check HTTP Response Status Code Is 422 -- GitLab From 9c56f787775ef68544fafc02848530aa37e80be9 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Mon, 25 Oct 2021 10:16:32 +0500 Subject: [PATCH 11/22] delete unused variables from variables.txt file --- .../environment/variables.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt index 887bff0d9..1a2939584 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt @@ -5,17 +5,17 @@ ${NFVMANO_SCHEMA} https ${AUTHORIZATION_TOKEN} Bearer 0b79bab50daca910b000d4f1a2b675d604257e42 ${NEG_AUTHORIZATION_TOKEN} Bearer negativetoken -#${WRONG_AUTHORIZATION_TOKEN} Bearer XXXXXWRONGXXXXX + ${BAD_AUTHORIZATION_TOKEN} Bear sometoken ${CONTENT_TYPE_JSON} application/json ${ACCEPT_JSON} application/json ${CONTENT_TYPE_PATCH} application/merge-patch+json ${AUTH_USAGE} 1 -#${FIELD_USAGE} 1 + ${NFVMANO_CHECKS_NOTIF_ENDPOINT} 1 ## If true, during subscription, the FUT performs a get to the notification endpoint -#${NFVMANO_ALLOWS_DUPLICATE_SUBS} 1 + ${apiRoot} / ${apiMajorVersion} v2 @@ -41,8 +41,8 @@ ${callback_endpoint} /subscriptions ${filter_ok} callbackUri=${callbackUri} ${filter_ko} erroneousFilter=erroneous ${callback_endpoint_fwd} /endpoint/check -#${callback_endpoint_error} /subs_404 -#${sleep_interval} 20s + + ${total_polling_time} 2 min ${polling_interval} 10 sec -- GitLab From be744b0ff664c8710e396157798c4095f481f176 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 12:50:45 +0500 Subject: [PATCH 12/22] update schemas --- .gitignore | 2 +- .../schemas/ChangeStateNotification.json | 288 +++---- .../schemas/ChangeStateOpOcc.json | 162 ++-- .../schemas/ChangeStateOpOccs.json | 21 +- .../schemas/CimSubscription.json | 204 ++--- .../schemas/CimSubscriptions.json | 25 +- .../InformationChangedNotification.json | 154 ++-- .../schemas/ManoConfigModifications.json | 169 ++--- .../schemas/ManoEntity.json | 701 ++++++++++-------- .../schemas/ManoServiceInterface.json | 372 +++++----- .../ManoServiceInterfaceModifications.json | 186 ++--- .../schemas/ManoServiceInterfaces.json | 88 +-- .../schemas/PeerEntities.json | 65 +- .../schemas/PeerEntity.json | 387 +++++----- SOL009/README.md | 2 +- 15 files changed, 1433 insertions(+), 1393 deletions(-) diff --git a/.gitignore b/.gitignore index 94620f93e..4655030ac 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,4 @@ build/ dist/ libspecs/ -/.vscode \ No newline at end of file +.vscode/ diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json index fc3b68c99..960b9e7d0 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json @@ -1,151 +1,151 @@ { - "description": "This type represents a Change state operation occurrence.\n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "notificationType": { - "description": "Discriminator for the different notification types. Shall be set to \"ChangeStateNotification\" for this notification type.\n", - "type": "string" - }, - "subscriptionId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "timestamp": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "changeStateOpOccId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "stateChangedTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "changeStateOperationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } + "description": "This type represents a Change state operation occurrence.\n", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timestamp", + "changeStateOpOccId", + "stateChangedTime", + "changeStateOperationState", + "managedObjectRef", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationType": { + "description": "Discriminator for the different notification types. Shall be set to \"ChangeStateNotification\" for this notification type.\n", + "type": "string" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timestamp": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "changeStateOpOccId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "stateChangedTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "changeStateOperationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] }, - "required": [ - "type", - "objectId" - ] - }, - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } }, - "_links": { - "description": "Links to resources related to this notification.\n", - "type": "object", - "properties": { - "subscription": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "objectInstance": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + "required": [ + "type", + "objectId" + ] + }, + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "_links": { + "description": "Links to resources related to this notification.\n", + "type": "object", + "properties": { + "subscription": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "changeStateOpOcc": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "objectInstance": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } } }, - "required": [ - "subscription", - "objectInstance", - "changeStateOpOcc" - ] - } - }, - "required": [ - "id", - "notificationType", - "subscriptionId", - "timestamp", - "changeStateOpOccId", - "stateChangedTime", - "changeStateOperationState", - "managedObjectRef", - "_links" - ] - } \ No newline at end of file + "changeStateOpOcc": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "subscription", + "objectInstance", + "changeStateOpOcc" + ] + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json index f9238e4d2..b0c3c9178 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json @@ -1,85 +1,85 @@ { - "description": "This type represents a Change state operation occurrence. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "operationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "stateEnteredTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } + "description": "This type represents a Change state operation occurrence. \n", + "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "managedObjectRef" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "stateEnteredTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] }, - "required": [ - "type", - "objectId" - ] - }, - "changeOperationalStateRequest": { - "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", - "type": "string", - "enum": [ - "START", - "STOP", - "RESTART" - ] - }, - "changeAdministrativeStateRequest": { - "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", - "type": "string", - "enum": [ - "LOCK", - "UNLOCK" - ] + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } }, - "operationParams": { - "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" - } + "required": [ + "type", + "objectId" + ] + }, + "changeOperationalStateRequest": { + "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", + "type": "string", + "enum": [ + "START", + "STOP", + "RESTART" + ] + }, + "changeAdministrativeStateRequest": { + "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", + "type": "string", + "enum": [ + "LOCK", + "UNLOCK" + ] }, - "required": [ - "id", - "operationState", - "stateEnteredTime", - "startTime", - "managedObjectRef" - ] - } \ No newline at end of file + "operationParams": { + "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json index 7c203be47..9f57c2454 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json @@ -1,7 +1,15 @@ -{ "type": "array", - "items": { +{ + "type": "array", + "items": { "description": "This type represents a Change state operation occurrence. \n", "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "managedObjectRef" + ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", @@ -75,13 +83,6 @@ "operationParams": { "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" } - }, - "required": [ - "id", - "operationState", - "stateEnteredTime", - "startTime", - "managedObjectRef" - ] + } } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json index 819a5d99e..1a7e924ed 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json @@ -1,113 +1,113 @@ { - "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "filter": { - "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. \n", - "type": "object", - "properties": { - "manoEntitySubscriptionFilter": { - "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", - "type": "object", - "properties": { - "manoEntityId": { + "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", + "type": "object", + "required": [ + "id", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "filter": { + "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", + "type": "object", + "properties": { + "manoEntitySubscriptionFilter": { + "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", + "type": "object", + "properties": { + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "manoServiceIds": { + "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceNames": { + "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "manoServiceInterfaceIds": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceInterfaceNames": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "consumedManoInterfaceIds": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" - }, - "manoServiceIds": { - "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceNames": { - "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "manoServiceInterfaceIds": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceInterfaceNames": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "consumedManoInterfaceIds": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - } - }, - "consumedManoInterfaceNames": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } } - } - }, - "notificationTypes": { - "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "InformationChangedNotification", - "ChangeStateNotification" - ] - } - } - } - }, - "callbackUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", + }, + "consumedManoInterfaceNames": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { "type": "string" } } } }, - "required": [ - "self" - ] + "notificationTypes": { + "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "InformationChangedNotification", + "ChangeStateNotification" + ] + } + } } }, - "required": [ - "id", - "callbackUri", - "_links" - ] - } \ No newline at end of file + "callbackUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json index 6ac082d31..a7578f88d 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json @@ -1,14 +1,20 @@ -{ "type": "array", - "items": { +{ + "type": "array", + "items": { "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", "type": "object", + "required": [ + "id", + "callbackUri", + "_links" + ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", "type": "string" }, "filter": { - "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. \n", + "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", "type": "object", "properties": { "manoEntitySubscriptionFilter": { @@ -67,7 +73,7 @@ } }, "notificationTypes": { - "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n", + "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", "type": "array", "items": { "type": "string", @@ -105,13 +111,6 @@ "self" ] } - }, - "required": [ - "id", - "callbackUri", - "_links" - ] - } - - + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json index 941a4bb5c..696f45239 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json @@ -1,81 +1,81 @@ { - "description": "This type represents a notification that is sent when data about configuration and information of the NFV-MANO functional entity have been changed.\n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "notificationType": { - "description": "Discriminator for the different notification types. Shall be set to \"InformationChangedNotification\" for this notification type.\n", - "type": "string" - }, - "subscriptionId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "timeStamp": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "informationChangedTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "manoEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "changedInfo": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - }, - "_links": { - "description": "Links to resources related to this notification.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "subscription": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + "description": "This type represents a notification that is sent when data about configuration and information of the NFV-MANO functional entity have been changed.\n", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timeStamp", + "informationChangedTime", + "manoEntityId", + "changedInfo", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationType": { + "description": "Discriminator for the different notification types. Shall be set to \"InformationChangedNotification\" for this notification type.\n", + "type": "string" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timeStamp": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "informationChangedTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "changedInfo": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + }, + "_links": { + "description": "Links to resources related to this notification.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } } }, - "required": [ - "self" - ] - } - }, - "required": [ - "id", - "notificationType", - "subscriptionId", - "timeStamp", - "informationChangedTime", - "manoEntityId", - "changedInfo", - "_links" - ] - } \ No newline at end of file + "subscription": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json index 7970b361e..ea15fde7d 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json @@ -1,99 +1,86 @@ { - "description": "This type represents attribute modifications that were performed on the \"NFV-MANO entity\" resource of the producer NFV-MANO functional entity. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoConfigModificationRequest\" data structure. \n", - "type": "object", - "properties": { - "name": { - "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3\n", - "type": "string" - }, - "description": { - "description": "If present, this attribute signals modifications of the \"description\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3.\n", - "type": "string" - }, - "clockSyncs": { - "description": "If present, this attribute signals modifications of the \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", - "type": "array", - "items": { - "description": "This type represents parameters for connecting to an NTP server. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "type": { - "description": "Type of clock synchronization.\nPermitted values:\n - NTP: For Network Time Protocol (NTP) based clock synchronization.\n - OTHER: For other types of clock synchronization.\n", - "type": "string", - "enum": [ - "NTP", - "OTHER" - ] - }, - "ntpServerInfo": { - "description": "Information for the NTP based clock synchronization. Shall be present if type = \"NTP\".\n", - "type": "object", - "properties": { - "ipAddress": { - "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", - "type": "string", - "format": "IP" - }, - "hostname": { - "description": "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n", - "type": "string" - } + "description": "This type represents attribute modifications that were performed on the \"NFV-MANO entity\" resource of the producer NFV-MANO functional entity. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoConfigModificationRequest\" data structure. \n", + "type": "object", + "properties": { + "name": { + "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3\n", + "type": "string" + }, + "description": { + "description": "If present, this attribute signals modifications of the \"description\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3.\n", + "type": "string" + }, + "clockSyncs": { + "description": "If present, this attribute signals modifications of the \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents parameters for connecting to an NTP server. * NOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Type of clock synchronization.\nPermitted values:\n - NTP: For Network Time Protocol (NTP) based clock synchronization.\n - OTHER: For other types of clock synchronization.\n", + "type": "string", + "enum": [ + "NTP", + "OTHER" + ] + }, + "ntpServerInfo": { + "description": "Information for the NTP based clock synchronization. Shall be present if type = \"NTP\".\n", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type": "string", + "format": "IP" + }, + "hostname": { + "description": "Indicates the hostname of the NTP server. See note.\n", + "type": "string" } - }, - "otherClockSyncParams": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" } }, - "required": [ - "id", - "type" - ] - } - }, - "clockSyncsDeleteIds": { - "description": "If present, this attribute signals modifications of certain entries in \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", - "type": "array", - "items": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" + "otherClockSyncParams": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } } - }, - "defaultLogCompileBySizeValue": { - "description": "Unsigned integer\n", - "type": "number" - }, - "defaultLogCompileByTimerValue": { - "description": "Unsigned integer\n", - "type": "number" - }, - "manoServiceModifications": { - "description": "If present, this attribute signals modifications of the \"manoServices\" attribute array in the \"ManoEntity\", as defined in clause 5.6.2.3.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "If present, this attribute signals modification of the \"name\" attribute in the \"ManoService\".\n", - "type": "string" - }, - "description": { - "description": "If present, this attribute signals modification of the \"description\" attribute in the \"ManoService\".\n", - "type": "string" - } + } + }, + "defaultLogCompileBySizeValue": { + "description": "Unsigned integer\n", + "type": "number" + }, + "defaultLogCompileByTimerValue": { + "description": "Unsigned integer\n", + "type": "number" + }, + "manoServiceModifications": { + "description": "If present, this attribute signals modifications of the \"manoServices\" attribute array in the \"ManoEntity\", as defined in clause 5.6.2.3.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" }, - "required": [ - "id" - ] - } + "name": { + "description": "If present, this attribute signals modification of the \"name\" attribute in the \"ManoService\".\n", + "type": "string" + }, + "description": { + "description": "If present, this attribute signals modification of the \"description\" attribute in the \"ManoService\".\n", + "type": "string" + } + }, + "required": [ + "id" + ] } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json index 388b9e00e..b78f2a698 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json @@ -1,192 +1,272 @@ { - "description": "This type represents an NFV-MANO functional entity.\n", - "type": "object", - "required": [ - "id", - "type", - "name", - "description", - "provider", - "softwareVersion", - "manoConfigurableParams", - "manoApplicationState", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "type": { - "description": "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM" - ] - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "description": { - "description": "Human-readable description of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "provider": { - "description": "Information about the provider of the NFV-MANO functional entity. It typically includes the name of the provider.\n", - "type": "string" - }, - "softwareVersion": { - "description": "The version of the software of the NFV-MANO functional entity. $ref: \"../components/SOL009_schemas.yaml#/components/schemas/Version\"\n" - }, - "manoEntityComponents": { - "description": "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n", - "type": "array", - "items": { - "description": "This type represents information of a deployed component realizing part of an NFV-MANO functional entity. It is optional for the API producer to support this type. \n", - "type": "object", - "properties": { - "id": { + "description": "This type represents an NFV-MANO functional entity. * NOTE 1:\tIt shall be present when \"type\" attribute is \"NFVO\", and it shall be absent in any other case. * NOTE 2:\tIt shall be present when \"type\" attribute is \"VNFM\", and it shall be absent in any other case. * NOTE 3:\tIt shall be present when \"type\" attribute is \"VIM\", and it shall be absent in any other case. * NOTE 4:\tThe information about the NFV-MANO services offered by a specific type of NFV-MANO functional\n entity is specified by the manoServices attribute.\n* NOTE 5:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute. * NOTE 6:\tIt shall be present when \"type\" attribute is \"WIM\", and it shall be absent in any other case.\n", + "type": "object", + "required": [ + "id", + "type", + "name", + "description", + "provider", + "softwareVersion", + "manoConfigurableParams", + "manoApplicationState", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "type": { + "description": "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\t The NFV-MANO functional entity is a VIM.\n - WIM The NFV-MANO functional entity is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM" + ] + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "provider": { + "description": "Information about the provider of the NFV-MANO functional entity. It typically includes the name of the provider.\n", + "type": "string" + }, + "softwareVersion": { + "description": "A version.\n", + "type": "string" + }, + "manoEntityComponents": { + "description": "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. See note 5.\n", + "type": "array", + "items": { + "description": "This type represents information of a deployed component realizing part of an NFV-MANO functional entity. It is optional for the API producer to support this type. \n", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "manoServiceIds": { + "description": "References to the NFV-MANO services that depend on the NFV-MANO functional entity component. The identifier of the ManoService is referred. A service may depend on multiple components. Multiple services may depend on the same component.\n", + "type": "array", + "items": { "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", "type": "string" - }, - "manoServiceIds": { - "description": "References to the NFV-MANO services that depend on the NFV-MANO functional entity component. The identifier of the ManoService is referred. A service may depend on multiple components. Multiple services may depend on the same component.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } } + } + } + } + }, + "manoServices": { + "description": "Information about the NFV-MANO services provided by the NFV-MANO functional entity.\n", + "type": "array", + "items": { + "description": "This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity. * NOTE:\tA cardinality greater than one supports having different interface versions or api Endpoints\n to be used for accessing the same instance of an NFV-MANO service.\n", + "type": "object", + "required": [ + "id", + "name", + "description", + "manoServiceInterfaceIds", + "_links" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" }, - "required": [ - "id" + "name": { + "description": "Human-readable name of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "manoServiceInterfaceIds": { + "description": "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. See note\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "minItems": 1 + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "manoServiceInterfaces": { + "description": "Link to the \"individual NFV-MANO service interface\" resources with information about the associated interfaces to the NFV-MANO service.\n", + "type": "array", + "items": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "minItems": 1 + } + }, + "required": [ + "manoServiceInterfaces" + ] + } + } + } + }, + "manoConfigurableParams": { + "description": "# Warning: No definition found in the document ManoConfigurableParams\n" + }, + "manoApplicationState": { + "description": "Information and current values of the NFV-MANO functional entityΓÇÖs application state. \n", + "type": "object", + "required": [ + "operationalState", + "administrativeState", + "usageState" + ], + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" ] } - }, - "manoServices": { - "description": "Information about the NFV-MANO services provided by the NFV-MANO functional entity.\n", - "type": "array", - "items": { - "description": "This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity.\n", + } + }, + "nfvoSpecificInfo": { + "description": "This type represents information attributes specific to an NFVO entity, and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined.\n", + "type": "object", + "required": [ + "supportedVnfdFormats", + "supportedNsdFormats" + ], + "properties": { + "maxOnboardedNsdNum": { + "description": "Maximum number of NSDs that can be on-boarded on the NFVO. See note 2.\n", + "type": "integer" + }, + "maxOnboardedVnfPkgNum": { + "description": "Maximum number of VNF Packages that can be on-boarded on the NFVO. See note 2.\n", + "type": "integer" + }, + "supportedVnfdFormats": { + "description": "Supported VNFD data formats.\n", "type": "object", "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" + "vnfdFormat": { + "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] }, - "name": { - "description": "Human-readable name of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "standardVersion": { + "description": "A version.\n", "type": "string" + } + }, + "required": [ + "vnfdFormat", + "standardVersion" + ] + }, + "supportedNsdFormats": { + "description": "Supported NSD data formats.\n", + "type": "object", + "properties": { + "nsdFormat": { + "description": "Name of the NSD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] }, - "description": { - "description": "Human-readable description of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "standardVersion": { + "description": "A version.\n", "type": "string" - }, - "manoServiceInterfaceIds": { - "description": "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "minItems": 1 - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "manoServiceInterfaces": { - "description": "Link to the \"individual NFV-MANO service interface\" resources with information about the associated interfaces to the NFV-MANO service.\n", - "type": "array", - "items": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "minItems": 1 - } - }, - "required": [ - "manoServiceInterfaces" - ] } }, "required": [ - "id", - "name", - "description", - "manoServiceInterfaceIds", - "_links" + "nsdFormat", + "standardVersion" ] } - }, - "manoConfigurableParams": { - "description": "# Warning: No definition found in the document ManoConfigurableParams\n" - }, - "manoApplicationState": { - "description": "Information and current values of the NFV-MANO functional entity’s application state. \n", - "type": "object", - "required": [ - "operationalState", - "administrativeState", - "usageState" - ], - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } - } - }, - "nfvoSpecificInfo": { - "description": "This type represents information attributes specific to an NFVO entity, and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. \n", - "type": "object", - "properties": { - "maxOnboardedNsdNum": { - "description": "Maximum number of NSDs that can be on-boarded on the NFVO. \nNOTE: If this attribute is not present, the value of this parameter is undefined.\n", - "type": "integer" - }, - "maxOnboardedVnfPkgNum": { - "description": "Maximum number of VNF Packages that can be on-boarded on the NFVO. \nNOTE: If this attribute is not present, the value of this parameter is undefined.\n", - "type": "integer" + } + }, + "vnfmSpecificInfo": { + "description": "This type represents information attributes specific to a VNFM entity, and that can be relevant to more than one NFV-MANO service offered by a VNFM entity. * NOTE:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n", + "type": "object", + "required": [ + "resoruceMgmtModeSupport", + "managedVnfInstanceInfos", + "supportedVnfdFormats" + ], + "properties": { + "resoruceMgmtModeSupport": { + "description": "The supported resource management modes of the VNFM.\nPermitted values:\n - DIRECT: The VNFM supports direct mode only.\n - INDIRECT: The VNFM supports indirect mode only.\n - BOTH: The VNFM supports both direct and indirect mode.\n", + "type": "string", + "enum": [ + "DIRECT", + "INDIRECT", + "BOTH" + ] + }, + "managedVnfInstanceInfos": { + "description": "The kinds of VNF instances that can be managed, e.g. to determine the compatibility of a VNF with certain VNFM according to the vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).\n", + "type": "array", + "items": { + "type": "string" }, - "supportedVnfdFormats": { - "description": "Supported VNFD data formats.\n", + "minItems": 1 + }, + "supportedVnfdFormats": { + "description": "Supported VNFD data formats.\n", + "type": "array", + "items": { "type": "object", "properties": { "vnfdFormat": { @@ -207,169 +287,148 @@ "standardVersion" ] }, - "supportedNsdFormats": { - "description": "Supported NSD data formats.\n", - "type": "object", - "properties": { - "nsdFormat": { - "description": "Name of the NSD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } + "minItems": 1 + } + } + }, + "vimSpecificInfo": { + "description": "This type represents information attributes specific to a VIM entity, and that can be relevant to more than one NFV-MANO service offered by a VIM entity.\n", + "type": "object" + }, + "wimSpecificInfo": { + "description": "This type represents information attributes specific to a WIM entity, and that can be relevant to more than one NFV MANO service offered by a WIM entity.\n", + "type": "object", + "required": [ + "maxMscsNums", + "maxMsncNum", + "mscsLayerProtocolSupport" + ], + "properties": { + "maxMscsNums": { + "description": "Maximum number of MSCS that the WIM can manage.\n", + "type": "object", + "required": [ + "numMscs" + ], + "properties": { + "numMscs": { + "description": "Maximum number of MSCS.\n", + "type": "integer" }, - "required": [ - "nsdFormat", - "standardVersion" - ] + "criteriaNumMscs": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } } }, - "required": [ - "supportedVnfdFormats", - "supportedNsdFormats" - ] - }, - "vnfmSpecificInfo": { - "description": "This type represents information attributes specific to a VNFM entity, and that can be relevant to more than one NFV-MANO service offered by a VNFM entity.\n", - "type": "object", - "properties": { - "resoruceMgmtModeSupport": { - "description": "The supported resource management modes of the VNFM.\nPermitted values:\n - DIRECT: The VNFM supports direct mode only.\n - INDIRECT: The VNFM supports indirect mode only.\n - BOTH: The VNFM supports both direct and indirect mode.\n", - "type": "string", - "enum": [ - "DIRECT", - "INDIRECT", - "BOTH" - ] - }, - "managedVnfInstanceInfos": { - "description": "The kinds of VNF instances that can be managed, e.g. to determine the compatibility of a VNF with certain VNFM according to the vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - }, - "supportedVnfdFormats": { - "description": "Supported VNFD data formats.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "vnfdFormat": { - "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } - }, - "required": [ - "vnfdFormat", - "standardVersion" - ] + "maxMsncNum": { + "description": "Maximum number of MSNC that the WIM can manage\n", + "type": "object", + "required": [ + "numMsnc" + ], + "properties": { + "numMsnc": { + "description": "Maximum number of MSNC..\n", + "type": "integer" }, - "minItems": 1 + "criteriaNumMsnc": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } } }, - "required": [ - "resoruceMgmtModeSupport", - "managedVnfInstanceInfos", - "supportedVnfdFormats" - ] - }, - "vimSpecificInfo": { - "description": "This type represents information attributes specific to a VIM entity, and that can be relevant to more than one NFV-MANO service offered by a VIM entity.\n", - "type": "object" - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "required": [ - "self", - "manoServiceInterfaces", - "peerEntities", - "changeState", - "changeStateOpOccs" - ], - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + "mscsLayerProtocolSupport": { + "description": "List of protocols of particular layers used to realize an MSCS that are supported by the WIM.\nPermitted values:\n - EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432.\n - EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214.\n - VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified\n in IETF RFC 4761 and IETF RFC.\n - VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2\n Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074.\n - VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074.\n - BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364.\n", + "type": "string", + "enum": [ + "EVPN_BGP_MPLS", + "EVPN_VPWS", + "VPLS_BGP", + "VPLS_LDP_L2TP", + "VPWS_LDP_L2TP", + "BGP_IP_VPN" + ] + } + } + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "required": [ + "self", + "manoServiceInterfaces", + "peerEntities", + "changeState", + "changeStateOpOccs" + ], + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "manoServiceInterfaces": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "manoServiceInterfaces": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "peerEntities": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "peerEntities": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "changeState": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "changeState": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } - }, - "changeStateOpOccs": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + } + }, + "changeStateOpOccs": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" } } } } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json index 16b7cc3fe..bcedca867 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json @@ -1,215 +1,215 @@ { - "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "providerSpecificApiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" + "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "providerSpecificApiVersion", + "apiVersion", + "apiEndpoint", + "supportedOperations", + "interfaceState" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "providerSpecificApiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Exposed API endpoint of the interface.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } }, - "apiEndpoint": { - "description": "Exposed API endpoint of the interface.\n", + "required": [ + "apiUri" + ] + }, + "maxConcurrentIntOpNumber": { + "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", + "type": "integer" + }, + "supportedOperations": { + "description": "Information about supported operations of this interface.\n", + "type": "array", + "items": { "type": "object", "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "operationName": { + "description": "Name of the operation supported on the interface.\n", "type": "string" }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" + "maxConcurrentOpNumber": { + "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", + "type": "integer" } }, "required": [ - "apiUri" + "operationName" ] }, - "maxConcurrentIntOpNumber": { - "description": "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n", - "type": "integer" - }, - "supportedOperations": { - "description": "Information about supported operations of this interface.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "operationName": { - "description": "Name of the operation supported on the interface.\n", - "type": "string" - }, - "maxConcurrentOpNumber": { - "description": "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n", - "type": "integer" - } - }, - "required": [ - "operationName" + "minItems": 1 + }, + "interfaceState": { + "description": "State of the NFV-MANO service interface.\n", + "properties": { + "operationalState": { + "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING" ] }, - "minItems": 1 + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + } }, - "interfaceState": { - "description": "State of the NFV-MANO service interface.\n", - "properties": { - "operationalState": { - "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "required": [ + "operationalState", + "administrativeState", + "usageState" + ] + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { "type": "string", "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" + "TLS_TUNNEL", + "OAUTH2" ] }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } + "minItems": 1 }, - "required": [ - "operationalState", - "administrativeState", - "usageState" - ] - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. \n", - "type": "object", - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "webFingerHost" - ] - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "authServerId" - ] - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", "type": "string" - }, - "minItems": 1 + } } }, - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ] - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.", - "type": "array", - "items": { + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", "type": "string" - }, - "minItems": 1 + } } }, - "required": [ - "tlsTunnelCipherSuites" - ] + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } } }, - "required": [ - "authType", - "oauthServerInfo" - ] - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } } }, - "required": [ - "id", - "name", - "type", - "standardVersion", - "providerSpecificApiVersion", - "apiVersion", - "apiEndpoint", - "supportedOperations", - "interfaceState" - ] - } \ No newline at end of file + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json index 080fc11f2..696a8c11e 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json @@ -1,105 +1,105 @@ { - "description": "This type represents attribute modifications that were performed on an Individual NFV-MANO service interface\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoServiceInterfaceModificationRequest\" data structure. If applicable, additional attributes of the \"ManoServiceInterface\" data structure that were modified implicitly shall also be provided. \n", - "type": "object", - "properties": { - "name": { - "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoServiceInterface\", as defined in clause 5.6.2.11.\n", - "type": "string" - }, - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. \n", - "type": "object", - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 + "description": "This type represents attribute modifications that were performed on an Individual NFV-MANO service interface\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoServiceInterfaceModificationRequest\" data structure. If applicable, additional attributes of the \"ManoServiceInterface\" data structure that were modified implicitly shall also be provided. * NOTE:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all\n to the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided\n in a response message.\n", + "type": "object", + "properties": { + "name": { + "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoServiceInterface\", as defined in clause 5.6.2.11.\n", + "type": "string" + }, + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "webFingerHost" - ] - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "authServerId" - ] - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", "type": "string" - }, - "minItems": 1 + } } }, - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ] - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.", - "type": "array", - "items": { + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", "type": "string" - }, - "minItems": 1 + } } }, - "required": [ - "tlsTunnelCipherSuites" - ] + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } } }, - "required": [ - "authType", - "oauthServerInfo" - ] - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } } + }, + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json index ad71446bf..5ba68faae 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json @@ -1,7 +1,19 @@ -{ "type": "array", - "items": { - "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. \n", +{ + "type": "array", + "items": { + "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "providerSpecificApiVersion", + "apiVersion", + "apiEndpoint", + "supportedOperations", + "interfaceState" + ], "properties": { "id": { "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", @@ -53,7 +65,7 @@ ] }, "maxConcurrentIntOpNumber": { - "description": "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n", + "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", "type": "integer" }, "supportedOperations": { @@ -67,7 +79,7 @@ "type": "string" }, "maxConcurrentOpNumber": { - "description": "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n", + "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", "type": "integer" } }, @@ -115,8 +127,12 @@ ] }, "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. \n", + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], "properties": { "authType": { "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", @@ -133,53 +149,53 @@ "oauthServerInfo": { "description": "OAuth 2.0 authorization server information and configuration.\n", "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], "properties": { "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", "type": "object", + "required": [ + "webFingerHost" + ], "properties": { "webFingerHost": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } - }, - "required": [ - "webFingerHost" - ] + } }, "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", + "description": "Configuration data used to setup the authorization server identifier. See note.\n", "type": "object", + "required": [ + "authServerId" + ], "properties": { "authServerId": { "description": "String formatted according to IETF RFC 3986.\n", "type": "string" } - }, - "required": [ - "authServerId" - ] + } }, "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", "type": "array", "items": { - "type": "string" - }, - "minItems": 1 + "type": "string", + "minItems": 1 + } } - }, - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ] + } }, "tlsTunnelInfo": { "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", "type": "object", "properties": { "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.", + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", "type": "array", "items": { "type": "string" @@ -191,28 +207,12 @@ "tlsTunnelCipherSuites" ] } - }, - "required": [ - "authType", - "oauthServerInfo" - ] + } }, "metadata": { "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", "type": "object" } - }, - "required": [ - "id", - "name", - "type", - "standardVersion", - "providerSpecificApiVersion", - "apiVersion", - "apiEndpoint", - "supportedOperations", - "interfaceState" - ] + } } - } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json index c7e85d04b..75811a050 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json @@ -1,7 +1,15 @@ -{ "type": "array", - "items": { - "description": "This type represents an individual peer entity. \n", +{ + "type": "array", + "items": { + "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", "type": "object", + "required": [ + "id", + "peerEntityId", + "name", + "type", + "peerEntityState" + ], "properties": { "id": { "description": "An identifier with the intention of being globally unique.\n", @@ -16,7 +24,7 @@ "type": "string" }, "type": { - "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n", + "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", "type": "string", "enum": [ "NFVO", @@ -24,7 +32,8 @@ "VIM", "WIM", "EM", - "OSS" + "OSS", + "WIM" ] }, "description": { @@ -32,16 +41,20 @@ "type": "string" }, "consumedManoInterfaces": { - "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "array", - "items": { - "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. \n", + "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "apiVersion", + "apiEndpoint" + ], "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, "name": { "description": "Human-readable name of the NFV-MANO interface.\n", "type": "string" @@ -84,7 +97,7 @@ ] }, "securityInfo": { - "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity.\n", + "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", "type": "object", "required": [ "authType", @@ -108,7 +121,7 @@ "type": "object", "properties": { "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", "type": "object", "required": [ "webFingerHost" @@ -122,7 +135,7 @@ } }, "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", + "description": "Configuration data used to setup the authorization server identifier. See note.\n", "type": "object", "required": [ "authServerId" @@ -161,15 +174,7 @@ } } } - }, - "required": [ - "id", - "name", - "type", - "standardVersion", - "apiVersion", - "apiEndpoint" - ] + } } }, "peerEntityState": { @@ -202,14 +207,6 @@ "administrativeState" ] } - }, - "required": [ - "id", - "peerEntityId", - "name", - "type", - "peerEntityState" - ] + } } - } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json index cbf0cbe24..e168b2a11 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json @@ -1,212 +1,209 @@ { - "description": "This type represents an individual peer entity. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "peerEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM", - "WIM", - "EM", - "OSS" - ] - }, - "description": { - "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "consumedManoInterfaces": { - "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "array", - "items": { - "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. \n", - "type": "object", - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO interface.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } + "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", + "type": "object", + "required": [ + "id", + "peerEntityId", + "name", + "type", + "peerEntityState" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "peerEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM", + "EM", + "OSS", + "WIM" + ] + }, + "description": { + "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "consumedManoInterfaces": { + "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "apiVersion", + "apiEndpoint" + ], + "properties": { + "name": { + "description": "Human-readable name of the NFV-MANO interface.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" }, - "required": [ - "apiUri" - ] + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } }, - "securityInfo": { - "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 + "required": [ + "apiUri" + ] + }, + "securityInfo": { + "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", "type": "string", - "minItems": 1 + "format": "uri" } } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", "type": "string", - "minItems": 1 + "format": "uri" } } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } } } } } - }, - "required": [ - "id", - "name", - "type", - "standardVersion", - "apiVersion", - "apiEndpoint" - ] - } - }, - "peerEntityState": { - "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", - "type": "object", - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] } - }, - "required": [ - "operationalState", - "administrativeState" - ] + } } }, - "required": [ - "id", - "peerEntityId", - "name", - "type", - "peerEntityState" - ] - } \ No newline at end of file + "peerEntityState": { + "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", + "type": "object", + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + } + }, + "required": [ + "operationalState", + "administrativeState" + ] + } + } +} \ No newline at end of file diff --git a/SOL009/README.md b/SOL009/README.md index bb1592d77..68272f4f0 100644 --- a/SOL009/README.md +++ b/SOL009/README.md @@ -2,5 +2,5 @@ This folder includes the NFV API conformance test descriptions for NFV SOL009 APIs. -The reference spec version is v3.3.1: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf +The reference spec version is v3.5.1: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_nfv-sol009v030501p.pdf -- GitLab From b42b80692ffd9f6755c355e60655fd05ccb42674 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 14:14:47 +0500 Subject: [PATCH 13/22] update document number to v3.5.1 --- .../ChangeInterfaceStateTask.robot | 14 +++---- .../ChangeNFVMANOEntityStateTask.robot | 12 +++--- .../ChangeStateOperationOccurrences.robot | 32 ++++++++-------- .../IndividualNFVMANOServiceInterface.robot | 18 ++++----- .../IndividualPeerEntity.robot | 18 ++++----- ...vidualStateChangeOperationOccurrence.robot | 14 +++---- .../IndividualSubscription.robot | 14 +++---- .../NFVMANOEntity.robot | 16 ++++---- .../NFVMANOServiceInterfaces.robot | 32 ++++++++-------- .../NotificationEndpoint.robot | 8 ++-- .../Notifications.robot | 18 ++++----- .../PeerEntities.robot | 38 +++++++++---------- .../Subscriptions.robot | 24 ++++++------ 13 files changed, 129 insertions(+), 129 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeInterfaceStateTask.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeInterfaceStateTask.robot index 4d58d8b4b..1ec2b5161 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeInterfaceStateTask.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeInterfaceStateTask.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Change interface state task ... Test title: POST Change interface state task ... Test objective: The objective is send put request to change the state of the NFV-MANO service interface produced by the NFV-MANO functional entity ... Pre-conditions: none - ... Reference: clause 5.5.12.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: interface status changed @@ -27,7 +27,7 @@ POST Change interface state task - Conflict ... Test title: POST Change interface state task - Conflict ... Test objective: The objective is to test that request to cchange the state of the NFV-MANO service interface produced by the NFV-MANO functional entity failed due to a conflict with the state of the NFV-MANO entity resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -40,7 +40,7 @@ GET Change interface state task - Method not implemented ... Test title: GET Change interface state task - Method not implemented ... Test objective: The objective is to test that GET method is not allowed to retrieve the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -52,7 +52,7 @@ PUT Change interface state task - Conflict - Method not implemented ... Test title: PUT Change interface state task - Conflict - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to update the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -64,7 +64,7 @@ PATCH Change interface state task - Conflict - Method not implemented ... Test title: PATCH Change interface state task - Conflict - Method not implemented ... Test objective: The objective is to test that PATCH method is not allowed to update the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -76,7 +76,7 @@ DELETE Change interface state task - Conflict - Method not implemented ... Test title: DELETE Change interface state task - Conflict - Method not implemented ... Test objective: The objective is to test that DELETE method is not allowed to delete the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.12.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.12.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeNFVMANOEntityStateTask.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeNFVMANOEntityStateTask.robot index e450afa03..594da210d 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeNFVMANOEntityStateTask.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeNFVMANOEntityStateTask.robot @@ -12,7 +12,7 @@ POST NFV-MANO functional entity application state change ... Test title: POST NFV-MANO functional entity application state change ... Test objective: The objective is to request state change of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: entity status changed @@ -26,7 +26,7 @@ POST NFV-MANO functional entity application state change - Conflict ... Test title: POST NFV-MANO functional entity application state change - Conflict ... Test objective: The objective is to test that request to change the state of the NFV-MANO functional entity application fails due to a conflict with the state of the NFV-MANO entity resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -39,7 +39,7 @@ GET NFV-MANO functional entity application state change - Method not implemented ... Test title: GET NFV-MANO functional entity application state change - Method not implemented ... Test objective: The objective is to test that GET method is not allowed to retrieve the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -51,7 +51,7 @@ PUT NFV-MANO functional entity application state change - Method not implemented ... Test title: PUT NFV-MANO functional entity application state change - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to update the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -63,7 +63,7 @@ PATCH NFV-MANO functional entity application state change - Method not implement ... Test title: PATCH NFV-MANO functional entity application state change - Method not implemented ... Test objective: The objective is to test that PATCH method is not allowed to update the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -75,7 +75,7 @@ DELETE NFV-MANO functional entity application state change - Method not implemen ... Test title: DELETE NFV-MANO functional entity application state change - Method not implemented ... Test objective: The objective is to test that DELETE method is not allowed to delete the changed state of the NFV-MANO functional entity application. ... Pre-conditions: none - ... Reference: clause 5.5.7.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.7.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeStateOperationOccurrences.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeStateOperationOccurrences.robot index 7f60fe749..564e36cfd 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeStateOperationOccurrences.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/ChangeStateOperationOccurrences.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Change State Operation Occurrences - Method not implemented ... Test title: POST Change State Operation Occurrences - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET Change State Operation Occurrences ... Test title: GET Change State Operation Occurrences ... Test objective: The objective is to query status information about multiple change state operation occurrences, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET Change State Operation Occurrences - invalid attribute-based filter ... Test title: GET Change State Operation Occurrences - invalid attribute-based filter ... Test objective: The objective is to test that the retrieval of Change State Operation Occurrences fails when using invalid attribute-based filter, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -51,7 +51,7 @@ GET Change State Operation Occurrences - invalid attribute selector ... Test title: GET Change State Operation Occurrences - invalid attribute selector ... Test objective: The objective is to test that the retrieval of Change State Operation Occurrences fails when using invalid attribute selector, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -64,7 +64,7 @@ GET Change State Operation Occurrences - Bad Request Response too Big ... Test title: GET Change State Operation Occurrences - Bad Request Response too Big ... Test objective: The objective is to test that the retrieval of Change State Operation Occurrences fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -77,7 +77,7 @@ GET Change State Operation Occurrences with attribute-based filter ... Test title: GET Change State Operation Occurrences with attribute-based filter ... Test objective: The objective is to query status information about multiple change state operation occurrences with attribute filters, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -90,7 +90,7 @@ GET Change State Operation Occurrences with "all_fields" attribute selector ... Test title: GET Change State Operation Occurrences with "all_fields" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrences with "all_fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -103,7 +103,7 @@ GET Change State Operation Occurrences with "exclude_default" attribute selector ... Test title: GET Change State Operation Occurrence with "exclude_default" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrence with "exclude_default" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -116,7 +116,7 @@ GET Change State Operation Occurrences with "fields" attribute selector ... Test title: GET Change State Operation Occurrences with "fields" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrences with fields attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -129,7 +129,7 @@ GET Change State Operation Occurrences with "exclude_fields" attribute selector ... Test title: GET Change State Operation Occurrences with "exclude_fields" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrences with "exclude_fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -142,7 +142,7 @@ GET Change State Operation Occurrences with Paged Response ... Test title: GET Change State Operation Occurrence with Paged Response ... Test objective: The objective is to query Change State Operation Occurrence to get Paged Response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -155,7 +155,7 @@ GET Change State Operation Occurrences with "fields" and "exclude_default" attri ... Test title: GET Change State Operation Occurrences with "fields" and "exclude_default" attribute selector ... Test objective: The objective is to retrieve Change State Operation Occurrences with fields and exclude default attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -168,7 +168,7 @@ PUT Change State Operation Occurrences - Method not implemented ... Test title: PUT Change State Operation Occurrences - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -180,7 +180,7 @@ PATCH Change State Operation Occurrences - Method not implemented ... Test title: PATCH Change State Operation Occurrences - Method not implemented ... Test objective: The objective is to test that PATCH method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -192,7 +192,7 @@ DELETE Change State Operation Occurrences - Method not implemented ... Test title: DELETE Change State Operation Occurrences - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.8.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.8.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualNFVMANOServiceInterface.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualNFVMANOServiceInterface.robot index caea555e4..68b51c9e8 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualNFVMANOServiceInterface.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualNFVMANOServiceInterface.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Individual NFV-MANO Service Interface - Method not implemented ... Test title: POST Individual NFV-MANO Service Interface - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET Individual NFV-MANO Service Interface ... Test title: GET Individual NFV-MANO Service Interface ... Test objective: The objective is to query status information about an NFV-MANO service interface of the producer NFV-MANO functional entity by reading an "Individual NFV-MANO service interface" resource, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET Individual NFV-MANO Service Interface - Not Found ... Test title: GET Individual NFV-MANO Service Interface - Not Found ... Test objective: The objective is to test the retrieval of information about an NFV-MANO service interface of the producer NFV-MANO functional entity by reading an "Individual NFV-MANO service interface" resource fails when the resource is not present. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -51,7 +51,7 @@ PUT Individual NFV-MANO Service Interface - Method not implemented ... Test title: PUT Individual NFV-MANO Service Interface - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -63,7 +63,7 @@ PATCH Individual NFV-MANO Service Interface ... Test title: PATCH Individual NFV-MANO Service Interface ... Test objective: This method modifies the Individual NFV-MANO Service Interface resource, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: Individual NFV-MANO Service Interface resource is already created. - ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The Individual NFV-MANO Service Interface is modified by the operation @@ -76,7 +76,7 @@ PATCH Individual NFV-MANO Service Interface - Conflict ... Test title: PATCH Individual NFV-MANO Service Interface - Conflict ... Test objective: The objective is to test that the modification of the Individual NFV-MANO Service Interface resource failed due to a conflict with the state of the Individual NFV-MANO Service Interface resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: Individual NFV-MANO Service Interface resource is already created. - ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The Individual NFV-MANO Service Interface is not modified by the operation @@ -89,7 +89,7 @@ PATCH Individual NFV-MANO Service Interface - PreCondition Failed ... Test title: PATCH Individual NFV-MANO Service Interface - PreCondition Failed ... Test objective: The objective is to test that the modification of the Individual NFV-MANO Service Interface resource failed because precondition given in an HTTP request header is not fulfilled and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: Individual NFV-MANO Service Interface resource is already created. - ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The Individual NFV-MANO Service Interface is not modified by the operation @@ -102,7 +102,7 @@ DELETE Individual NFV-MANO Service Interface - Method not implemented ... Test title: DELETE Individual NFV-MANO Service Interface - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.11.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.11.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualPeerEntity.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualPeerEntity.robot index f6e5a7225..5e8d57e00 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualPeerEntity.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualPeerEntity.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Individual Peer Entity - Method not implemented ... Test title: POST Individual Peer Entity - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.14.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET Individual Peer Entity ... Test title: GET Individual Peer Entity ... Test objective: The objective is to retrieves information and configuration hold in the producer NFV-MANO functional entity with regards to a peer entity by reading an individual peer entity resource ... Pre-conditions: none - ... Reference: clause 5.5.14.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET Individual Peer Entity - Not Found ... Test title: GET Individual Peer Entity - Not Found ... Test objective: The objective is to test the retrieval of information and configuration hold in the producer NFV-MANO functional entity with regards to a peer entity by reading an individual peer entity resource fails when the resource is not present. ... Pre-conditions: none - ... Reference: clause 5.5.14.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -50,7 +50,7 @@ PUT Individual Peer Entity - Method not implemented ... Test title: PUT Individual Peer Entity - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.14.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -62,7 +62,7 @@ PATCH Individual Peer Entity ... Test title: PATCH Individual Peer Entity ... Test objective: This method modifies configuration and information of the producer NFV-MANO functional entity with regards to a peer functional entity by updating the corresponding "Individual peer entity" resource. ... Pre-conditions: At least one Peer Entity resource is created - ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: Peer Entity Resource is modified by the operation @@ -75,7 +75,7 @@ PATCH Individual Peer Entity - Conflict ... Test title: PATCH Individual Peer Entity - Conflict ... Test objective: The objective is to test that the modification of configuration and information of the producer NFV-MANO functional entity with regards to a peer functional entity by updating the corresponding "Individual peer entity" resource failed due to a conflict with the state of the Individual Peer Entity resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity resource is created - ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: Peer Entity Resource is not modified by the operation @@ -88,7 +88,7 @@ PATCH Individual Peer Entity - PreCondition Failed ... Test title: PATCH Individual Peer Entity - PreCondition Failed ... Test objective: The objective is to test that the modification of the Individual Peer Entity resource failed because precondition given in an HTTP request header is not fulfilled and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity resource is created - ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: Peer Entity Resource is not modified by the operation @@ -101,7 +101,7 @@ DELETE Individual Peer Entity - Method not implemented ... Test title: DELETE Individual Peer Entity - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.14.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.14.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualStateChangeOperationOccurrence.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualStateChangeOperationOccurrence.robot index c9797ea9e..cc058006b 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualStateChangeOperationOccurrence.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualStateChangeOperationOccurrence.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Individual Change State Operation Occurrence - Method not implemented ... Test title: POST Individual Change State Operation Occurrence - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET Individual Change State Operation Occurrence ... Test title: GET Individual Change State Operation Occurrence ... Test objective: The objective is to query status information about Individual change state operation occurrence. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET Individual Change State Operation Occurrence - Not Found ... Test title: GET Individual Change State Operation Occurrence - Not Found ... Test objective: The objective is to test the retrieval of information about individual change state operation occurence fails when the resource is not present. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -50,7 +50,7 @@ PUT Individual Change State Operation Occurrence - Method not implemented ... Test title: PUT Individual Change State Operation Occurrence - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -62,7 +62,7 @@ PATCH Individual Change State Operation Occurrence - Method not implemented ... Test title: PATCH Individual Change State Operation Occurrence - Method not implemented ... Test objective: The objective is to test that PATCH method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -74,7 +74,7 @@ DELETE Individual Change State Operation Occurrence - Method not implemented ... Test title: DELETE Individual Change State Operation Occurrence - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.9.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.9.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualSubscription.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualSubscription.robot index e20248234..e01857ac8 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualSubscription.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/IndividualSubscription.robot @@ -12,7 +12,7 @@ GET Individual Subscription ... Test title: GET Individual Subscription ... Test objective: The objective is to test the retrieval of individual subscription and perform a JSON schema and content validation of the returned subscription data structure ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.5.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -26,7 +26,7 @@ GET Individual Subscription - invalid resource identifier ... Test title: GET Individual Subscription - invalid resource identifier ... Test objective: The objective is to test that the retrieval of an individual subscription fails when using an invalid resource identifier ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.5.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ DELETE Individual Subscription ... Test title: DELETE Individual Subscription ... Test objective: The objective is to test the deletion of an individual subscription ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.5.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The resource is not available anymore in the NFV-MANO @@ -51,7 +51,7 @@ DELETE Individual Subscription - invalid resource identifier ... Test title: DELETE Individual Subscription - invalid resource identifier ... Test objective: The objective is to test that the deletion of an individual subscription fails when using an invalid resource identifier ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.5.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -63,7 +63,7 @@ POST Individual Subscription - Method not implemented ... Test title: POST Individual Subscription - Method not implemented ... Test objective: The objective is to test that POST method is not allowed to create a new Subscription ... Pre-conditions: none - ... Reference: clause 5.5.5.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -75,7 +75,7 @@ PUT Individual Subscription - Method not implemented ... Test title: PUT Individual Subscription - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to update an existing subscription ... Pre-conditions: none - ... Reference: clause 5.5.5.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -87,7 +87,7 @@ PATCH Individual Subscription - Method not implemented ... Test title: PATCH Individual Subscription - Method not implemented ... Test objective: The objective is to test that PATCH method is not allowed to modify an existing subscription ... Pre-conditions: none - ... Reference: clause 5.5.5.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.5.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOEntity.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOEntity.robot index 74a29921b..07bb06953 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOEntity.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOEntity.robot @@ -13,7 +13,7 @@ POST NFV-MANO entity - Method not implemented ... Test title: POST NFV-MANO entity - Method not implemented ... Test objective: The objective is to test that POST method is not allowed to create an NFV-MANO Entity. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET NFV-MANO entity ... Test title: Get NFV-MANO entity ... Test objective: The objective is to test the retrieval of information about an NFV-MANO functional entity by reading the NFV-MANO entity resource and perform a JSON schema and content validation of the collected job data structure. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET NFV-MANO entity - Not Found ... Test title: Get NFV-MANO entity - Not Found ... Test objective: The objective is to test the retrieval of information about an NFV-MANO functional entity by reading the NFV-MANO entity resource fails when the resource is not present. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -50,7 +50,7 @@ PUT NFV-MANO entity - Method not implemented ... Test title: PUT NFV-MANO entity - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to update an NFV-MANO Entity. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -62,7 +62,7 @@ PATCH NFV-MANO entity ... Test title: PATCH NFV-MANO entity ... Test objective: The objective is to test that PATCH method modifies the NFV-MANO entity resource and perform a JSON schema and content validation of the modified response. ... Pre-conditions: NFV-MANO entity resource is already created. - ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The NFV-MANO entity is modified by the operation @@ -75,7 +75,7 @@ PATCH NFV-MANO entity - Conflict ... Test title: PATCH NFV-MANO entity - Conflict ... Test objective: The objective is to test that the modification of the NFV-MANO entity resource failed due to a conflict with the state of the NFV-MANO entity resource and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: NFV-MANO entity resource is already created. - ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The NFV-MANO entity is not modified by the operation @@ -88,7 +88,7 @@ PATCH NFV-MANO entity - PreCondition Failed ... Test title: PATCH NFV-MANO entity - PreCondition Failed ... Test objective: The objective is to test that the modification of the NFV-MANO entity resource failed because precondition given in an HTTP request header is not fulfilled and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: NFV-MANO entity resource is already created. - ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The NFV-MANO entity is not modified by the operation @@ -101,7 +101,7 @@ DELETE NFV-MANO entity - Method not implemented ... Test title: DELETE NFV-MANO entity - Method not implemented ... Test objective: The objective is to test that DELETE method is not allowed to delete an NFV-MANO Entity. ... Pre-conditions: none - ... Reference: clause 5.5.3.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.3.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOServiceInterfaces.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOServiceInterfaces.robot index 938b1b0f4..028f92fb4 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOServiceInterfaces.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOServiceInterfaces.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST NFV-MANO Service Interfaces - Method not implemented ... Test title: POST NFV-MANO Service Interfaces - Method not implemented ... Test objective: The objective is to test that POST method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ GET NFV-MANO Service Interfaces ... Test title: GET NFV-MANO Service Interfaces ... Test objective: The objective is to query status information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -38,7 +38,7 @@ GET NFV-MANO Service Interfaces - invalid attribute-based filter ... Test title: GET NFV-MANO Service Interfaces - invalid attribute-based filter ... Test objective: The objective is to test that the retrieval of NFV-MANO Service Interfaces fails when using invalid attribute-based filter, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -51,7 +51,7 @@ GET NFV-MANO Service Interfaces - invalid attribute selector ... Test title: GET NFV-MANO Service Interfaces - invalid attribute selector ... Test objective: The objective is to test that the retrieval of NFV-MANO Service Interfaces fails when using invalid attribute selector, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -64,7 +64,7 @@ GET NFV-MANO Service Interfaces - Bad Request Response too Big ... Test title: GET NFV-MANO Service Interfaces - Bad Request Response too Big ... Test objective: The objective is to test that the retrieval of NFV-MANO Service Interfaces fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -77,7 +77,7 @@ GET NFV-MANO Service Interfaces with attribute-based filter ... Test title: GET NFV-MANO Service Interfaces with attribute-based filter ... Test objective: The objective is to query status information about multiple NFV-MANO service interfaces of the NFV-MANO functional entities with attribute filters, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -90,7 +90,7 @@ GET NFV-MANO Service Interfaces with "all_fields" attribute selector ... Test title: GET NFV-MANO Service Interface with "all_fields" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with "all_fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -103,7 +103,7 @@ GET NFV-MANO Service Interfaces with "exclude_default" attribute selector ... Test title: GET NFV-MANO Service Interfaces with "exclude_default" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with "exclude_default" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -116,7 +116,7 @@ GET NFV-MANO Service Interfaces with "fields" attribute selector ... Test title: GET NFV-MANO Service Interfaces with "fields" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with fields attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -129,7 +129,7 @@ GET NFV-MANO Service Interfaces with "exclude_fields" attribute selector ... Test title: GET NFV-MANO Service Interfaces with "exclude_fields" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with "exclude_fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -142,7 +142,7 @@ GET NFV-MANO Service Interfaces with "exclude_default" and "fields" attribute se ... Test title: GET NFV-MANO Service Interfaces with "exclude_default" and "fields" attribute selector ... Test objective: The objective is to retrieve NFV-MANO Service Interfaces with "exclude_default" and "fields" attribute selector, and perform the JSON schema validation of the HTTP response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -155,7 +155,7 @@ GET NFV-MANO Service Interfaces with Paged Response ... Test title: GET NFV-MANO Service Interfaces with Paged Response ... Test objective: The objective is to query NFV-MANO Service Interface to get Paged Response. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -168,7 +168,7 @@ PUT NFV-MANO Service Interfaces - Method not implemented ... Test title: PUT NFV-MANO Service Interfaces - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -180,7 +180,7 @@ PATCH NFV-MANO Service Interfaces - Method not implemented ... Test title: PATCH NFV-MANO Service Interfaces - Method not implemented ... Test objective: The objective is to test that PATCH method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -192,7 +192,7 @@ DELETE NFV-MANO Service Interfaces - Method not implemented ... Test title: DELETE NFV-MANO Service Interfaces - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.10.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.10.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NotificationEndpoint.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NotificationEndpoint.robot index 7ffefd8e7..23b3e92f6 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NotificationEndpoint.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NotificationEndpoint.robot @@ -13,7 +13,7 @@ Information Changed Notification ... Test title: Information Changed Notification ... Test objective: The objective is to test that Information Changed Notification is delivered with success to the notification consumer ... Pre-conditions: A subscription for information availability notification is available in the NFV-MANO. - ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_Notif_Endpoint ... Applicability: none ... Post-Conditions: none @@ -25,7 +25,7 @@ Change State Notification ... Test title: Change State Notification ... Test objective: The objective is to test that Change State Notification is delivered with success to the notification consumer ... Pre-conditions: A subscription for change state notification is available in the NFV-MANO. - ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_Notif_Endpoint ... Applicability: none ... Post-Conditions: none @@ -56,7 +56,7 @@ Post Information Changed Notification ${body}= Format String ${template} subscriptionId=${subscriptionId} Post ${callbackResp} ${body} ${outputResponse}= Output response - Set Global Variable ${response} ${outputResponse} + Set Global Variable ${response} ${outputResponse} Post Change State Notification log Trying to perform a POST to get notification @@ -67,4 +67,4 @@ Post Change State Notification ${body}= Format String ${template} subscriptionId=${subscriptionId} changeStateOpOccId=${changeStateOpOccId} Post ${callbackResp} ${body} ${outputResponse}= Output response - Set Global Variable ${response} ${outputResponse} + Set Global Variable ${response} ${outputResponse} diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Notifications.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Notifications.robot index 7e00c3d89..3e936b98e 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Notifications.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Notifications.robot @@ -1,5 +1,5 @@ *** Setting *** -Resource environment/variables.txt +Resource environment/variables.txt Suite Setup Create Sessions Suite Teardown Terminate All Processes kill=true Library MockServerLibrary @@ -16,7 +16,7 @@ Information Changed Notification ... Test title: Information Changed Notification ... Test objective: The objective is to test the dispatch of Information Changed Notification when configuration or information is changed in the NFV-MANO, and perform a JSON schema and content validation of the delivered notification. The action that triggers the notification under test is an explicit test step, but it is not performed by the test system. ... Pre-conditions: A subscription for information availability notifications is available in the NFV-MANO. - ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -29,7 +29,7 @@ Change State Notification ... Test title: Change State Notification ... Test objective: The objective is to test the dispatch of Change State Notification when state changes of the NFV-MANO functional entity and its managed objects, and perform a JSON schema and content validation of the delivered notification. The action that triggers the notification under test is an explicit test step, but it is not performed by the test system. ... Pre-conditions: A performance job is created, and a state change subscription is available in the NFV-MANO. - ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.6.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANOz ... Applicability: none ... Post-Conditions: none @@ -49,7 +49,7 @@ Trigger the cross of Change State (external action) Check Information Changed Notification Available Http POST Request Body Json Schema Is [Arguments] ${element} - ${schema}= Get File schemas/${element}.schema.json + ${schema}= Get File schemas/${element}.schema.json Configure Notification Forward ${schema} ${callback_endpoint} ${callback_endpoint_fwd} Check Information Changed Notification Available Http POST Request Body notificationType attribute Is @@ -61,7 +61,7 @@ Check Information Changed Notification Available Http POST Request Body notifica Check Change State Notification Http POST Request Body Json Schema Is [Arguments] ${element} - ${schema}= Get File schemas/${element}.schema.json + ${schema}= Get File schemas/${element}.schema.json Configure Notification Forward ${schema} ${callback_endpoint} ${callback_endpoint_fwd} @@ -85,7 +85,7 @@ Configure Notification Information Changed Notification Available Handler set to dictionary ${json} notificationType ${type} ${BODY}= evaluate json.dumps(${json}) json Log Creating mock request and response to handle status notification - &{req}= Create Mock Request Matcher POST ${endpoint} body_type="JSON" body=${BODY} + &{req}= Create Mock Request Matcher POST ${endpoint} body_type="JSON" body=${BODY} Set Global Variable ${notification_request} ${req} &{notification_response}= Create Mock Response status_code=204 Create Mock Expectation ${notification_request} ${notification_response} @@ -96,7 +96,7 @@ Configure Notification State Crossed Handler set to dictionary ${json} notificationType ${type} ${BODY}= evaluate json.dumps(${json}) json Log Creating mock request and response to handle status notification - &{req}= Create Mock Request Matcher POST ${endpoint} body_type="JSON" body=${BODY} + &{req}= Create Mock Request Matcher POST ${endpoint} body_type="JSON" body=${BODY} Set Global Variable ${notification_request} ${req} &{notification_response}= Create Mock Response status_code=204 Create Mock Expectation ${notification_request} ${notification_response} @@ -104,8 +104,8 @@ Configure Notification State Crossed Handler Configure Notification Forward [Arguments] ${schema} ${endpoint} ${endpoint_fwd} Log Creating mock Http POST forward to handle ${schema} - &{notification_tmp}= Create Mock Request Matcher POST ${endpoint} body_type="JSON_SCHEMA" body=${schema} - &{notification_fwd}= Create Mock Http Forward ${endpoint_fwd} + &{notification_tmp}= Create Mock Request Matcher POST ${endpoint} body_type="JSON_SCHEMA" body=${schema} + &{notification_fwd}= Create Mock Http Forward ${endpoint_fwd} Create Mock Expectation With Http Forward ${notification_tmp} ${notification_fwd} Create Sessions diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/PeerEntities.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/PeerEntities.robot index 2fe8eb548..dfbe06ecf 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/PeerEntities.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/PeerEntities.robot @@ -1,4 +1,4 @@ -** Settings *** +*** Settings *** Library JSONSchemaLibrary schemas/ Resource environment/variables.txt Library JSONLibrary @@ -13,7 +13,7 @@ POST Peer Entity ... Test title: POST Peer Entity ... Test objective: The objective is to creates in the producer NFV-MANO functional entity a new peer entity resource which contains configuration and information with regards to the peer functional entity and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: Peer Entity is created @@ -28,7 +28,7 @@ GET Peer Entities ... Test title: GET Peer Entities ... Test objective: The objective is to query information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -41,7 +41,7 @@ GET Peer Entities - invalid attribute-based filter ... Test title: GET Peer Entities - invalid attribute-based filter ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when using invalid attribute-based filter, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -54,7 +54,7 @@ GET Peer Entities - invalid attribute selector ... Test title: GET Peer Entities - invalid attribute selector ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when using invalid attribute selector, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -67,7 +67,7 @@ GET Peer Entities - Bad Request Response too Big ... Test title: GET Peer Entities - Bad Request Response too Big ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -80,7 +80,7 @@ GET Peer Entities with attribute-based filter ... Test title: GET Peer Entities with attribute-based filter ... Test objective: The objective is to query information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with attribute filters, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -93,7 +93,7 @@ GET Peer Entities with "all_fields" attribute selector ... Test title: GET Peer Entities with "all_fields" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with "all_fields" attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -106,7 +106,7 @@ GET Peer Entities with "exclude_default" attribute selector ... Test title: GET Peer Entities with "exclude_default" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with "exclude_default" attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -119,7 +119,7 @@ GET Peer Entities with "fields" attribute selector ... Test title: GET Peer Entities with "fields" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with fields attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -132,7 +132,7 @@ GET Peer Entities with "exclude_fields" attribute selector ... Test title: GET Peer Entities with "exclude_fields" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with "exclude_fields" attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -145,7 +145,7 @@ GET Peer Entities with "exclude_default" and "fields" attribute selector ... Test title: GET Peer Entities with "exclude_default" and "fields" attribute selector ... Test objective: The objective is to retrieve information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities with "exclude_default" and "fields" attribute selector, and perform the JSON schema validation of the returned job data structure. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -158,7 +158,7 @@ GET Peer Entity with Paged Response ... Test title: GET Peer Entity with Paged Response ... Test objective: The objective is to query information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities to get Paged Response. ... Pre-conditions: At least one Peer Entity is already created. - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -171,7 +171,7 @@ Get Peer Entity with malformed authorization token ... Test title: Get Peer Entity with malformed authorization token ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when using malformed authorization token. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The Peer Entity requires the usage of access tokens for authorizing the API requests. ... Post-Conditions: none @@ -183,7 +183,7 @@ Get Peer Entity without authorization token ... Test title: Get Peer Entity without authorization token ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when omitting the authorization token. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The Peer Entity requires the usage of access tokens for authorizing the API requests. ... Post-Conditions: none @@ -195,7 +195,7 @@ GET information about multiple alarms with expired or revoked authorization toke ... Test title: GET information about multiple alarms with expired or revoked authorization token ... Test objective: The objective is to test that the retrieval of information and configuration in the producer NFV-MANO functional entity with regards to multiple peer entities fails when using expired or revoked authorization token. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The Peer Entity requires the usage of access tokens for authorizing the API requests. ... Post-Conditions: none @@ -207,7 +207,7 @@ PUT Peer Entities - Method not implemented ... Test title: PUT Peer Entities - Method not implemented ... Test objective: The objective is to test that PUT method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -219,7 +219,7 @@ PATCH Peer Entities - Method not implemented ... Test title: PATCH Peer Entities - Method not implemented ... Test objective: The objective is to test that PATCH method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -231,7 +231,7 @@ DELETE Peer Entities - Method not implemented ... Test title: DELETE Peer Entities - Method not implemented ... Test objective: The objective is to test that DELETE method is not implemeted. ... Pre-conditions: none - ... Reference: clause 5.5.13.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.13.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 9ff981dd1..5d4d1f303 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -16,7 +16,7 @@ GET all Subscriptions ... Test title: GET all Subscriptions ... Test objective: The objective is to test the retrieval list of active subscriptions of API consumer and perform a JSON schema validation of the returned subscriptions data structure. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -29,7 +29,7 @@ GET Subscriptions with attribute-based filter ... Test title: GET Subscriptions with attribute-based filter ... Test objective: The objective is to test the retrieval of active subscriptions list of API consumer using attribute-based filter and perform a JSON schema validation of the collected indicators data structure. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -42,7 +42,7 @@ GET Subscriptions with Paged Response ... Test title: GET Subscriptions with Paged Response ... Test objective: The objective is to query information of active subscriptions list to of API consumer to get Paged Response. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: ... Post-Conditions: @@ -55,7 +55,7 @@ GET Subscriptions - invalid attribute-based filter ... Test title: GET Subscriptions - invalid attribute-based filter ... Test objective: The objective is to test that the retrieval of active subscriptions list of API consumer fails when using invalid attribute-based filters, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -69,7 +69,7 @@ GET Subscriptions - Bad Request Response too Big ... Test title: GET Subscriptions - Bad Request Response too Big ... Test objective: The objective is to test that the retrieval of active subscriptions list of API consumer fails when response is too big, and perform the JSON schema validation of the failed operation HTTP response. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -82,7 +82,7 @@ GET Subscriptions - invalid resource endpoint ... Test title: GET Subscriptions - invalid resource endpoint ... Test objective: The objective is to test that the retrieval of active subscriptions list of API consumer fails when using invalid resource endpoint. ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.2 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -94,7 +94,7 @@ Create new Subscription ... Test title: Create new Subscription ... Test objective: The objective is to test the creation of a new subscription and perform a JSON schema and content validation of the returned subscription data structure ... Pre-conditions: none - ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: The subscription is successfully set and it matches the issued subscription @@ -111,7 +111,7 @@ Create request for duplicated Subscription not creating duplicated subscriptions ... Test title: Create request for duplicated Subscription not creating duplicated subscriptions ... Test objective: The objective is to test the attempt of a creation of a duplicated subscription failed and check that no new subscription is created and a link to the original subscription is returned ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The NFV-MANO does not support the creation of duplicated subscriptions ... Post-Conditions: The existing Subscription returned is available in the NFV-MANO @@ -127,7 +127,7 @@ Create request for duplicated Subscription creating duplicated subscriptions ... Test title: Create request for duplicated Subscription creating duplicated subscriptions ... Test objective: The objective is to test the creation of a duplicated subscription and perform a JSON schema and content validation of the returned duplicated subscription data structure ... Pre-conditions: At least one subscription is available in the NFV-MANO. - ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: The NFV-MANO supports the creation of duplicated subscriptions ... Post-Conditions: The duplicated subscription is successfully set and it matches the issued subscription @@ -142,7 +142,7 @@ PUT Subscriptions - Method not implemented ... Test title: PUT Subscriptions - Method not implemented ... Test objective: The objective is to test that PUT method is not allowed to modify subscriptions ... Pre-conditions: none - ... Reference: clause 5.5.4.3.3 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.3 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -154,7 +154,7 @@ PATCH Subscriptions - Method not implemented ... Test title: PATCH Subscriptions - Method not implemented ... Test objective: The objective is to test that PATCH method is not allowed to update subscriptions ... Pre-conditions: none - ... Reference: clause 5.5.4.3.4 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.4 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none @@ -166,7 +166,7 @@ DELETE Subscriptions - Method not implemented ... Test title: DELETE Subscriptions - Method not implemented ... Test objective: The objective is to test that DELETE method is not allowed to delete subscriptions ... Pre-conditions: none - ... Reference: clause 5.5.4.3.5 - ETSI GS NFV-SOL 009 [7] v3.3.1 + ... Reference: clause 5.5.4.3.5 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none -- GitLab From 64f5c9963545c87d95f8a3c9afb18463f028e0ab Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 15:00:45 +0500 Subject: [PATCH 14/22] add POST unprocessable entity test case for subscriptions --- .../Subscriptions.robot | 19 ++++++++++-- .../schemas/ProblemDetails.schema.json | 30 ++++++++++++++++++- 2 files changed, 45 insertions(+), 4 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 5d4d1f303..ada4ec7a4 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -89,7 +89,7 @@ GET Subscriptions - invalid resource endpoint Get all Subscriptions Check HTTP Response Status Code Is 404 -Create new Subscription +POST Create new Subscription [Documentation] Test ID: 8.3.1.10.7 ... Test title: Create new Subscription ... Test objective: The objective is to test the creation of a new subscription and perform a JSON schema and content validation of the returned subscription data structure @@ -105,7 +105,7 @@ Create new Subscription Check Postcondition Subscription Is Set -Create request for duplicated Subscription not creating duplicated subscriptions +POST Create request for duplicated Subscription not creating duplicated subscriptions [Tags] no-duplicated-subs [Documentation] Test ID: 8.3.1.10.8 ... Test title: Create request for duplicated Subscription not creating duplicated subscriptions @@ -121,7 +121,7 @@ Create request for duplicated Subscription not creating duplicated subscriptions Check HTTP Response Header Contains Location Check Postcondition Subscription Resource Returned in Location Header Is Available -Create request for duplicated Subscription creating duplicated subscriptions +POST Create request for duplicated Subscription creating duplicated subscriptions [Tags] duplicated-subs [Documentation] Test ID: 8.3.1.10.9 ... Test title: Create request for duplicated Subscription creating duplicated subscriptions @@ -172,3 +172,16 @@ DELETE Subscriptions - Method not implemented ... Post-Conditions: none Send Delete Request for Subscriptions Check HTTP Response Status Code Is 405 + +POST Create a new subscription - Unprocessable Entity + [Documentation] Test ID: 8.3.1.10.13 + ... Test title: POST Create a new Subscription - Unprocessable Entity + ... Test objective: The objective is to test that content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. + ... Pre-conditions: none + ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 + ... Config ID: Config_prod_NFV-MANO + ... Applicability: none + ... Post-Conditions: none + Send Post Request for Subscription + Check HTTP Response Status Code Is 422 + Check HTTP Response Body Json Schema Is ProblemDetails diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ProblemDetails.schema.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ProblemDetails.schema.json index 2af3ef9b3..bd236d731 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ProblemDetails.schema.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ProblemDetails.schema.json @@ -1 +1,29 @@ -{ "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n", "type": "object", "required": [ "status", "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\".\n", "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).\n", "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.\n", "type": "integer" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.\n", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", "type": "string", "format": "URI" } }} \ No newline at end of file +{ + "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis 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].\n", + "type": "object", + "required": ["status", "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\".\n", + "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).\n", + "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.\n", + "type": "integer" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.\n", + "type": "string" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n", + "type": "string", + "format": "URI" + } + } +} -- GitLab From 229861a96b9526cb05a405e7bf6a1864e3f39add Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 15:39:39 +0500 Subject: [PATCH 15/22] update apiMajorVersion in variables.txt --- .../environment/variables.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt index 35efe08ef..b9aec98f2 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt @@ -18,7 +18,7 @@ ${NFVMANO_CHECKS_NOTIF_ENDPOINT} 1 ## If true, during subscription, th ${NFVMANO_ALLOWS_DUPLICATE_SUBS} 1 ${apiRoot} / -${apiMajorVersion} v1 +${apiMajorVersion} v2 ${apiName} nfvmanocim ${response} -- GitLab From bef781072eb74268cbcd952519c8885e2969a243 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 17:04:45 +0500 Subject: [PATCH 16/22] fix POST subscriptions - unprocessable entity test case --- .../NFVMANOCimKeywords.robot | 12 ++++++++++++ .../Subscriptions.robot | 4 ++-- .../environment/variables.txt | 1 + 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot index 44fb39106..cb1eb6210 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot @@ -675,6 +675,18 @@ Send Post Request for Subscription Run Keyword If ${NFVMANO_CHECKS_NOTIF_ENDPOINT} == 1 ... Check Notification Endpoint +Send Post Request for Subscription with Unreachable callbackUri + Set headers {"Content-Type": "${CONTENT_TYPE_JSON}"} + Set headers {"Accept": "${ACCEPT_JSON}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": ${AUTHORIZATION}"} + ${template}= Get File jsons/CimSubscriptionRequest.json + ${body_request}= Format String ${template} callback_uri=${unreachable_callback_uri} callback_endpoint=${callback_endpoint} + POST ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${body_request} + ${output}= Output response + Set Suite Variable ${response} ${output} + Run Keyword If ${NFVMANO_CHECKS_NOTIF_ENDPOINT} == 1 + ... Check Notification Endpoint + Check HTTP Response Body CimSubscription Attributes Values Match the Issued Subscription Log Check Response matches subscription ${template}= Get File jsons/CimSubscriptionRequest.json diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index ada4ec7a4..4cb9a4901 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -176,12 +176,12 @@ DELETE Subscriptions - Method not implemented POST Create a new subscription - Unprocessable Entity [Documentation] Test ID: 8.3.1.10.13 ... Test title: POST Create a new Subscription - Unprocessable Entity - ... Test objective: The objective is to test that content type of the payload body is supported and the payload body of a request contains syntactically correct data but the data cannot be processed. + ... Test objective: The objective is to test that for a POST request for a new subscription, if the test by NFV-MANO for notification endpoint fails, then error 422 will be returned. ... Pre-conditions: none ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO ... Applicability: none ... Post-Conditions: none - Send Post Request for Subscription + Send Post Request for Subscription with Unreachable callbackUri Check HTTP Response Status Code Is 422 Check HTTP Response Body Json Schema Is ProblemDetails diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt index b9aec98f2..b86b897ab 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt @@ -36,6 +36,7 @@ ${peerEntityId} ${callback_port} 9091 ${callback_uri} http://172.22.1.7:${callback_port} +${unreachable_callback_uri} http://unreachable_callback_uri-error-code-422 ${callback_endpoint} /subscriptions ${filter_ok} callbackUri=${callbackUri} ${filter_ko} erroneousFilter=erroneous -- GitLab From 091d9f0e1f2358522bb33e8c3f6430522002d238 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 17:09:52 +0500 Subject: [PATCH 17/22] rename schema files --- ...on => ChangeStateNotification.schema.json} | 300 +++--- ...pOcc.json => ChangeStateOpOcc.schema.json} | 168 ++-- ...ccs.json => ChangeStateOpOccs.schema.json} | 174 ++-- ...ption.json => CimSubscription.schema.json} | 224 ++--- ...ions.json => CimSubscriptions.schema.json} | 230 ++--- ...nformationChangedNotification.schema.json} | 160 ++-- ...on => ManoConfigModifications.schema.json} | 170 ++-- ...ManoEntity.json => ManoEntity.schema.json} | 866 +++++++++--------- ....json => ManoServiceInterface.schema.json} | 428 ++++----- ...ServiceInterfaceModifications.schema.json} | 208 ++--- ...json => ManoServiceInterfaces.schema.json} | 434 ++++----- ...Entities.json => PeerEntities.schema.json} | 422 ++++----- ...PeerEntity.json => PeerEntity.schema.json} | 416 ++++----- 13 files changed, 2100 insertions(+), 2100 deletions(-) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ChangeStateNotification.json => ChangeStateNotification.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ChangeStateOpOcc.json => ChangeStateOpOcc.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ChangeStateOpOccs.json => ChangeStateOpOccs.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{CimSubscription.json => CimSubscription.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{CimSubscriptions.json => CimSubscriptions.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{InformationChangedNotification.json => InformationChangedNotification.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoConfigModifications.json => ManoConfigModifications.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoEntity.json => ManoEntity.schema.json} (97%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoServiceInterface.json => ManoServiceInterface.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoServiceInterfaceModifications.json => ManoServiceInterfaceModifications.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{ManoServiceInterfaces.json => ManoServiceInterfaces.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{PeerEntities.json => PeerEntities.schema.json} (98%) rename SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/{PeerEntity.json => PeerEntity.schema.json} (98%) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.schema.json index 960b9e7d0..1d887a364 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateNotification.schema.json @@ -1,151 +1,151 @@ -{ - "description": "This type represents a Change state operation occurrence.\n", - "type": "object", - "required": [ - "id", - "notificationType", - "subscriptionId", - "timestamp", - "changeStateOpOccId", - "stateChangedTime", - "changeStateOperationState", - "managedObjectRef", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "notificationType": { - "description": "Discriminator for the different notification types. Shall be set to \"ChangeStateNotification\" for this notification type.\n", - "type": "string" - }, - "subscriptionId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "timestamp": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "changeStateOpOccId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "stateChangedTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "changeStateOperationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "required": [ - "type", - "objectId" - ] - }, - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "_links": { - "description": "Links to resources related to this notification.\n", - "type": "object", - "properties": { - "subscription": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "objectInstance": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "changeStateOpOcc": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - }, - "required": [ - "subscription", - "objectInstance", - "changeStateOpOcc" - ] - } - } +{ + "description": "This type represents a Change state operation occurrence.\n", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timestamp", + "changeStateOpOccId", + "stateChangedTime", + "changeStateOperationState", + "managedObjectRef", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationType": { + "description": "Discriminator for the different notification types. Shall be set to \"ChangeStateNotification\" for this notification type.\n", + "type": "string" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timestamp": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "changeStateOpOccId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "stateChangedTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "changeStateOperationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] + }, + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "required": [ + "type", + "objectId" + ] + }, + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "_links": { + "description": "Links to resources related to this notification.\n", + "type": "object", + "properties": { + "subscription": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "objectInstance": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "changeStateOpOcc": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "subscription", + "objectInstance", + "changeStateOpOcc" + ] + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.schema.json index b0c3c9178..53e9d8228 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOcc.schema.json @@ -1,85 +1,85 @@ -{ - "description": "This type represents a Change state operation occurrence. \n", - "type": "object", - "required": [ - "id", - "operationState", - "stateEnteredTime", - "startTime", - "managedObjectRef" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "operationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "stateEnteredTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "required": [ - "type", - "objectId" - ] - }, - "changeOperationalStateRequest": { - "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", - "type": "string", - "enum": [ - "START", - "STOP", - "RESTART" - ] - }, - "changeAdministrativeStateRequest": { - "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", - "type": "string", - "enum": [ - "LOCK", - "UNLOCK" - ] - }, - "operationParams": { - "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" - } - } +{ + "description": "This type represents a Change state operation occurrence. \n", + "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "managedObjectRef" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "stateEnteredTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] + }, + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "required": [ + "type", + "objectId" + ] + }, + "changeOperationalStateRequest": { + "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", + "type": "string", + "enum": [ + "START", + "STOP", + "RESTART" + ] + }, + "changeAdministrativeStateRequest": { + "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", + "type": "string", + "enum": [ + "LOCK", + "UNLOCK" + ] + }, + "operationParams": { + "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.schema.json index 9f57c2454..2c222b3b5 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ChangeStateOpOccs.schema.json @@ -1,88 +1,88 @@ -{ - "type": "array", - "items": { - "description": "This type represents a Change state operation occurrence. \n", - "type": "object", - "required": [ - "id", - "operationState", - "stateEnteredTime", - "startTime", - "managedObjectRef" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "operationState": { - "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED" - ] - }, - "stateEnteredTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "startTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "managedObjectRef": { - "description": "This type represents the identifier to reference a managed object of a particular type. \n", - "type": "object", - "properties": { - "type": { - "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", - "type": "string", - "enum": [ - "MANO_ENTITY", - "MANO_SERVICE", - "MANO_SERVICE_IF", - "CONSUMED_MANO_IF", - "MANO_ENTITY_COMPONENT" - ] - }, - "objectId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "subObjectId": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "required": [ - "type", - "objectId" - ] - }, - "changeOperationalStateRequest": { - "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", - "type": "string", - "enum": [ - "START", - "STOP", - "RESTART" - ] - }, - "changeAdministrativeStateRequest": { - "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", - "type": "string", - "enum": [ - "LOCK", - "UNLOCK" - ] - }, - "operationParams": { - "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" - } - } - } +{ + "type": "array", + "items": { + "description": "This type represents a Change state operation occurrence. \n", + "type": "object", + "required": [ + "id", + "operationState", + "stateEnteredTime", + "startTime", + "managedObjectRef" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "operationState": { + "description": "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n", + "type": "string", + "enum": [ + "PROCESSING", + "COMPLETED", + "FAILED" + ] + }, + "stateEnteredTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "startTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "managedObjectRef": { + "description": "This type represents the identifier to reference a managed object of a particular type. \n", + "type": "object", + "properties": { + "type": { + "description": "Indicates the type of managed object. Permitted values:\n - MANO_ENTITY\n - MANO_SERVICE\n - MANO_SERVICE_IF\n - CONSUMED_MANO_IF\n - MANO_ENTITY_COMPONENT\n\nThe \"MANO_ENTITY COMPONENT\" is only applicable if attribute \"manoEntityComponents\" in \"ManoEntity\" is supported by the API producer.\n", + "type": "string", + "enum": [ + "MANO_ENTITY", + "MANO_SERVICE", + "MANO_SERVICE_IF", + "CONSUMED_MANO_IF", + "MANO_ENTITY_COMPONENT" + ] + }, + "objectId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "subObjectId": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "required": [ + "type", + "objectId" + ] + }, + "changeOperationalStateRequest": { + "description": "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n", + "type": "string", + "enum": [ + "START", + "STOP", + "RESTART" + ] + }, + "changeAdministrativeStateRequest": { + "description": "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n", + "type": "string", + "enum": [ + "LOCK", + "UNLOCK" + ] + }, + "operationParams": { + "description": "Input parameters of the change state operation. This attribute shall be formatted according to the request data type of the related change state operation. \nThe following mapping between operationType and the data type of this attribute shall apply:\n - CHANGE_STATE: ChangeStateRequest\n \nThis attribute shall be present if this data type is returned in a response to reading an individual resource, and may be present according to the chosen attribute selector parameter if this data type is returned in a response to a query of a container resource.\n" + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.schema.json index 1a7e924ed..ced25bc5f 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscription.schema.json @@ -1,113 +1,113 @@ -{ - "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", - "type": "object", - "required": [ - "id", - "callbackUri", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "filter": { - "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", - "type": "object", - "properties": { - "manoEntitySubscriptionFilter": { - "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", - "type": "object", - "properties": { - "manoEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "manoServiceIds": { - "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceNames": { - "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "manoServiceInterfaceIds": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceInterfaceNames": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "consumedManoInterfaceIds": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - } - }, - "consumedManoInterfaceNames": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "notificationTypes": { - "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "InformationChangedNotification", - "ChangeStateNotification" - ] - } - } - } - }, - "callbackUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - }, - "required": [ - "self" - ] - } - } +{ + "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", + "type": "object", + "required": [ + "id", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "filter": { + "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", + "type": "object", + "properties": { + "manoEntitySubscriptionFilter": { + "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", + "type": "object", + "properties": { + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "manoServiceIds": { + "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceNames": { + "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "manoServiceInterfaceIds": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceInterfaceNames": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "consumedManoInterfaceIds": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + } + }, + "consumedManoInterfaceNames": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "notificationTypes": { + "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "InformationChangedNotification", + "ChangeStateNotification" + ] + } + } + } + }, + "callbackUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.schema.json index a7578f88d..2098ec69c 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/CimSubscriptions.schema.json @@ -1,116 +1,116 @@ -{ - "type": "array", - "items": { - "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", - "type": "object", - "required": [ - "id", - "callbackUri", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "filter": { - "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", - "type": "object", - "properties": { - "manoEntitySubscriptionFilter": { - "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", - "type": "object", - "properties": { - "manoEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "manoServiceIds": { - "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceNames": { - "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "manoServiceInterfaceIds": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - }, - "manoServiceInterfaceNames": { - "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "consumedManoInterfaceIds": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - } - }, - "consumedManoInterfaceNames": { - "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "notificationTypes": { - "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "InformationChangedNotification", - "ChangeStateNotification" - ] - } - } - } - }, - "callbackUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - }, - "required": [ - "self" - ] - } - } - } +{ + "type": "array", + "items": { + "description": "This type represents a subscription related to notifications about NFV-MANO configuration and information management changes\n", + "type": "object", + "required": [ + "id", + "callbackUri", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "filter": { + "description": "This type represents a subscription filter related to notifications about NFV-MANO configuration and information management. * NOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names\n of the notification types to facilitate automated code generation systems.\n", + "type": "object", + "properties": { + "manoEntitySubscriptionFilter": { + "description": "This type represents subscription filter criteria to match NFV-MANO functional entities and their associated managed objects. \n", + "type": "object", + "properties": { + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "manoServiceIds": { + "description": "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceNames": { + "description": "If present, match NFV-MANO services with an NFV-MANO service name listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "manoServiceInterfaceIds": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance identifier listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + }, + "manoServiceInterfaceNames": { + "description": "If present, match NFV-MANO functional entity produced interfaces with an instance Name listed in this attribute.\nThe attributes \"manoServiceInterfaceIds\" and \"manoServiceInterfaceNames\" are alternatives to reference to NFV-MANO functional entity produced interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + }, + "consumedManoInterfaceIds": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance identifier listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + } + }, + "consumedManoInterfaceNames": { + "description": "If present, match NFV-MANO functional entity consumed interfaces with an instance Name listed in this attribute.\nThe attributes \"consumedManoInterfaceIds\" and \"consumedManoInterfaceNames\" are alternatives to reference to NFV-MANO functional entity consumed interfaces in a filter. They should not be used both in the same filter instance, but one alternative should be chosen.\n", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "notificationTypes": { + "description": "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nSee note.\n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "InformationChangedNotification", + "ChangeStateNotification" + ] + } + } + } + }, + "callbackUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.schema.json index 696f45239..b906a3a5a 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/InformationChangedNotification.schema.json @@ -1,81 +1,81 @@ -{ - "description": "This type represents a notification that is sent when data about configuration and information of the NFV-MANO functional entity have been changed.\n", - "type": "object", - "required": [ - "id", - "notificationType", - "subscriptionId", - "timeStamp", - "informationChangedTime", - "manoEntityId", - "changedInfo", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "notificationType": { - "description": "Discriminator for the different notification types. Shall be set to \"InformationChangedNotification\" for this notification type.\n", - "type": "string" - }, - "subscriptionId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "timeStamp": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "informationChangedTime": { - "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", - "type": "string", - "format": "date-time" - }, - "manoEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "changedInfo": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - }, - "_links": { - "description": "Links to resources related to this notification.\n", - "type": "object", - "properties": { - "self": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "subscription": { - "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - }, - "required": [ - "self" - ] - } - } +{ + "description": "This type represents a notification that is sent when data about configuration and information of the NFV-MANO functional entity have been changed.\n", + "type": "object", + "required": [ + "id", + "notificationType", + "subscriptionId", + "timeStamp", + "informationChangedTime", + "manoEntityId", + "changedInfo", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "notificationType": { + "description": "Discriminator for the different notification types. Shall be set to \"InformationChangedNotification\" for this notification type.\n", + "type": "string" + }, + "subscriptionId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "timeStamp": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "informationChangedTime": { + "description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n", + "type": "string", + "format": "date-time" + }, + "manoEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "changedInfo": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + }, + "_links": { + "description": "Links to resources related to this notification.\n", + "type": "object", + "properties": { + "self": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "subscription": { + "description": "This type represents a link to a resource in a notification, using an absolute or relative URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + }, + "required": [ + "self" + ] + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.schema.json index ea15fde7d..9ecde8ddb 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoConfigModifications.schema.json @@ -1,86 +1,86 @@ -{ - "description": "This type represents attribute modifications that were performed on the \"NFV-MANO entity\" resource of the producer NFV-MANO functional entity. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoConfigModificationRequest\" data structure. \n", - "type": "object", - "properties": { - "name": { - "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3\n", - "type": "string" - }, - "description": { - "description": "If present, this attribute signals modifications of the \"description\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3.\n", - "type": "string" - }, - "clockSyncs": { - "description": "If present, this attribute signals modifications of the \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", - "type": "object", - "additionalProperties": { - "description": "This type represents parameters for connecting to an NTP server. * NOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "description": "Type of clock synchronization.\nPermitted values:\n - NTP: For Network Time Protocol (NTP) based clock synchronization.\n - OTHER: For other types of clock synchronization.\n", - "type": "string", - "enum": [ - "NTP", - "OTHER" - ] - }, - "ntpServerInfo": { - "description": "Information for the NTP based clock synchronization. Shall be present if type = \"NTP\".\n", - "type": "object", - "properties": { - "ipAddress": { - "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", - "type": "string", - "format": "IP" - }, - "hostname": { - "description": "Indicates the hostname of the NTP server. See note.\n", - "type": "string" - } - } - }, - "otherClockSyncParams": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } - } - }, - "defaultLogCompileBySizeValue": { - "description": "Unsigned integer\n", - "type": "number" - }, - "defaultLogCompileByTimerValue": { - "description": "Unsigned integer\n", - "type": "number" - }, - "manoServiceModifications": { - "description": "If present, this attribute signals modifications of the \"manoServices\" attribute array in the \"ManoEntity\", as defined in clause 5.6.2.3.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "If present, this attribute signals modification of the \"name\" attribute in the \"ManoService\".\n", - "type": "string" - }, - "description": { - "description": "If present, this attribute signals modification of the \"description\" attribute in the \"ManoService\".\n", - "type": "string" - } - }, - "required": [ - "id" - ] - } - } - } +{ + "description": "This type represents attribute modifications that were performed on the \"NFV-MANO entity\" resource of the producer NFV-MANO functional entity. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoConfigModificationRequest\" data structure. \n", + "type": "object", + "properties": { + "name": { + "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3\n", + "type": "string" + }, + "description": { + "description": "If present, this attribute signals modifications of the \"description\" attribute in \"ManoEntity\", as defined in clause 5.6.2.3.\n", + "type": "string" + }, + "clockSyncs": { + "description": "If present, this attribute signals modifications of the \"clockSyncs\" attribute in \"ManoEntityConfigurableParams\", as defined in clause 5.6.2.3.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents parameters for connecting to an NTP server. * NOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Type of clock synchronization.\nPermitted values:\n - NTP: For Network Time Protocol (NTP) based clock synchronization.\n - OTHER: For other types of clock synchronization.\n", + "type": "string", + "enum": [ + "NTP", + "OTHER" + ] + }, + "ntpServerInfo": { + "description": "Information for the NTP based clock synchronization. Shall be present if type = \"NTP\".\n", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n", + "type": "string", + "format": "IP" + }, + "hostname": { + "description": "Indicates the hostname of the NTP server. See note.\n", + "type": "string" + } + } + }, + "otherClockSyncParams": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } + } + }, + "defaultLogCompileBySizeValue": { + "description": "Unsigned integer\n", + "type": "number" + }, + "defaultLogCompileByTimerValue": { + "description": "Unsigned integer\n", + "type": "number" + }, + "manoServiceModifications": { + "description": "If present, this attribute signals modifications of the \"manoServices\" attribute array in the \"ManoEntity\", as defined in clause 5.6.2.3.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "If present, this attribute signals modification of the \"name\" attribute in the \"ManoService\".\n", + "type": "string" + }, + "description": { + "description": "If present, this attribute signals modification of the \"description\" attribute in the \"ManoService\".\n", + "type": "string" + } + }, + "required": [ + "id" + ] + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.schema.json similarity index 97% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.schema.json index b78f2a698..29484d403 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoEntity.schema.json @@ -1,434 +1,434 @@ -{ - "description": "This type represents an NFV-MANO functional entity. * NOTE 1:\tIt shall be present when \"type\" attribute is \"NFVO\", and it shall be absent in any other case. * NOTE 2:\tIt shall be present when \"type\" attribute is \"VNFM\", and it shall be absent in any other case. * NOTE 3:\tIt shall be present when \"type\" attribute is \"VIM\", and it shall be absent in any other case. * NOTE 4:\tThe information about the NFV-MANO services offered by a specific type of NFV-MANO functional\n entity is specified by the manoServices attribute.\n* NOTE 5:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute. * NOTE 6:\tIt shall be present when \"type\" attribute is \"WIM\", and it shall be absent in any other case.\n", - "type": "object", - "required": [ - "id", - "type", - "name", - "description", - "provider", - "softwareVersion", - "manoConfigurableParams", - "manoApplicationState", - "_links" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "type": { - "description": "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\t The NFV-MANO functional entity is a VIM.\n - WIM The NFV-MANO functional entity is a WIM.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM", - "WIM" - ] - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "description": { - "description": "Human-readable description of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "provider": { - "description": "Information about the provider of the NFV-MANO functional entity. It typically includes the name of the provider.\n", - "type": "string" - }, - "softwareVersion": { - "description": "A version.\n", - "type": "string" - }, - "manoEntityComponents": { - "description": "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. See note 5.\n", - "type": "array", - "items": { - "description": "This type represents information of a deployed component realizing part of an NFV-MANO functional entity. It is optional for the API producer to support this type. \n", - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "manoServiceIds": { - "description": "References to the NFV-MANO services that depend on the NFV-MANO functional entity component. The identifier of the ManoService is referred. A service may depend on multiple components. Multiple services may depend on the same component.\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - } - } - } - } - }, - "manoServices": { - "description": "Information about the NFV-MANO services provided by the NFV-MANO functional entity.\n", - "type": "array", - "items": { - "description": "This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity. * NOTE:\tA cardinality greater than one supports having different interface versions or api Endpoints\n to be used for accessing the same instance of an NFV-MANO service.\n", - "type": "object", - "required": [ - "id", - "name", - "description", - "manoServiceInterfaceIds", - "_links" - ], - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "description": { - "description": "Human-readable description of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "manoServiceInterfaceIds": { - "description": "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. See note\n", - "type": "array", - "items": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "minItems": 1 - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "properties": { - "manoServiceInterfaces": { - "description": "Link to the \"individual NFV-MANO service interface\" resources with information about the associated interfaces to the NFV-MANO service.\n", - "type": "array", - "items": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "minItems": 1 - } - }, - "required": [ - "manoServiceInterfaces" - ] - } - } - } - }, - "manoConfigurableParams": { - "description": "# Warning: No definition found in the document ManoConfigurableParams\n" - }, - "manoApplicationState": { - "description": "Information and current values of the NFV-MANO functional entityΓÇÖs application state. \n", - "type": "object", - "required": [ - "operationalState", - "administrativeState", - "usageState" - ], - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } - } - }, - "nfvoSpecificInfo": { - "description": "This type represents information attributes specific to an NFVO entity, and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined.\n", - "type": "object", - "required": [ - "supportedVnfdFormats", - "supportedNsdFormats" - ], - "properties": { - "maxOnboardedNsdNum": { - "description": "Maximum number of NSDs that can be on-boarded on the NFVO. See note 2.\n", - "type": "integer" - }, - "maxOnboardedVnfPkgNum": { - "description": "Maximum number of VNF Packages that can be on-boarded on the NFVO. See note 2.\n", - "type": "integer" - }, - "supportedVnfdFormats": { - "description": "Supported VNFD data formats.\n", - "type": "object", - "properties": { - "vnfdFormat": { - "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } - }, - "required": [ - "vnfdFormat", - "standardVersion" - ] - }, - "supportedNsdFormats": { - "description": "Supported NSD data formats.\n", - "type": "object", - "properties": { - "nsdFormat": { - "description": "Name of the NSD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } - }, - "required": [ - "nsdFormat", - "standardVersion" - ] - } - } - }, - "vnfmSpecificInfo": { - "description": "This type represents information attributes specific to a VNFM entity, and that can be relevant to more than one NFV-MANO service offered by a VNFM entity. * NOTE:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n", - "type": "object", - "required": [ - "resoruceMgmtModeSupport", - "managedVnfInstanceInfos", - "supportedVnfdFormats" - ], - "properties": { - "resoruceMgmtModeSupport": { - "description": "The supported resource management modes of the VNFM.\nPermitted values:\n - DIRECT: The VNFM supports direct mode only.\n - INDIRECT: The VNFM supports indirect mode only.\n - BOTH: The VNFM supports both direct and indirect mode.\n", - "type": "string", - "enum": [ - "DIRECT", - "INDIRECT", - "BOTH" - ] - }, - "managedVnfInstanceInfos": { - "description": "The kinds of VNF instances that can be managed, e.g. to determine the compatibility of a VNF with certain VNFM according to the vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - }, - "supportedVnfdFormats": { - "description": "Supported VNFD data formats.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "vnfdFormat": { - "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", - "type": "string", - "enum": [ - "TOSCA", - "YANG" - ] - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - } - }, - "required": [ - "vnfdFormat", - "standardVersion" - ] - }, - "minItems": 1 - } - } - }, - "vimSpecificInfo": { - "description": "This type represents information attributes specific to a VIM entity, and that can be relevant to more than one NFV-MANO service offered by a VIM entity.\n", - "type": "object" - }, - "wimSpecificInfo": { - "description": "This type represents information attributes specific to a WIM entity, and that can be relevant to more than one NFV MANO service offered by a WIM entity.\n", - "type": "object", - "required": [ - "maxMscsNums", - "maxMsncNum", - "mscsLayerProtocolSupport" - ], - "properties": { - "maxMscsNums": { - "description": "Maximum number of MSCS that the WIM can manage.\n", - "type": "object", - "required": [ - "numMscs" - ], - "properties": { - "numMscs": { - "description": "Maximum number of MSCS.\n", - "type": "integer" - }, - "criteriaNumMscs": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } - }, - "maxMsncNum": { - "description": "Maximum number of MSNC that the WIM can manage\n", - "type": "object", - "required": [ - "numMsnc" - ], - "properties": { - "numMsnc": { - "description": "Maximum number of MSNC..\n", - "type": "integer" - }, - "criteriaNumMsnc": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } - }, - "mscsLayerProtocolSupport": { - "description": "List of protocols of particular layers used to realize an MSCS that are supported by the WIM.\nPermitted values:\n - EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432.\n - EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214.\n - VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified\n in IETF RFC 4761 and IETF RFC.\n - VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2\n Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074.\n - VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074.\n - BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364.\n", - "type": "string", - "enum": [ - "EVPN_BGP_MPLS", - "EVPN_VPWS", - "VPLS_BGP", - "VPLS_LDP_L2TP", - "VPWS_LDP_L2TP", - "BGP_IP_VPN" - ] - } - } - }, - "_links": { - "description": "Links to resources related to this resource.\n", - "type": "object", - "required": [ - "self", - "manoServiceInterfaces", - "peerEntities", - "changeState", - "changeStateOpOccs" - ], - "properties": { - "self": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "manoServiceInterfaces": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "peerEntities": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "changeState": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "changeStateOpOccs": { - "description": "This type represents a link to a resource using an absolute URI.\n", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - } - } - } - } +{ + "description": "This type represents an NFV-MANO functional entity. * NOTE 1:\tIt shall be present when \"type\" attribute is \"NFVO\", and it shall be absent in any other case. * NOTE 2:\tIt shall be present when \"type\" attribute is \"VNFM\", and it shall be absent in any other case. * NOTE 3:\tIt shall be present when \"type\" attribute is \"VIM\", and it shall be absent in any other case. * NOTE 4:\tThe information about the NFV-MANO services offered by a specific type of NFV-MANO functional\n entity is specified by the manoServices attribute.\n* NOTE 5:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute. * NOTE 6:\tIt shall be present when \"type\" attribute is \"WIM\", and it shall be absent in any other case.\n", + "type": "object", + "required": [ + "id", + "type", + "name", + "description", + "provider", + "softwareVersion", + "manoConfigurableParams", + "manoApplicationState", + "_links" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "type": { + "description": "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\t The NFV-MANO functional entity is a VIM.\n - WIM The NFV-MANO functional entity is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM" + ] + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the NFV-MANO functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "provider": { + "description": "Information about the provider of the NFV-MANO functional entity. It typically includes the name of the provider.\n", + "type": "string" + }, + "softwareVersion": { + "description": "A version.\n", + "type": "string" + }, + "manoEntityComponents": { + "description": "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. See note 5.\n", + "type": "array", + "items": { + "description": "This type represents information of a deployed component realizing part of an NFV-MANO functional entity. It is optional for the API producer to support this type. \n", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "manoServiceIds": { + "description": "References to the NFV-MANO services that depend on the NFV-MANO functional entity component. The identifier of the ManoService is referred. A service may depend on multiple components. Multiple services may depend on the same component.\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + } + } + } + } + }, + "manoServices": { + "description": "Information about the NFV-MANO services provided by the NFV-MANO functional entity.\n", + "type": "array", + "items": { + "description": "This type represents information about an NFV-MANO service provided by the NFV-MANO functional entity. * NOTE:\tA cardinality greater than one supports having different interface versions or api Endpoints\n to be used for accessing the same instance of an NFV-MANO service.\n", + "type": "object", + "required": [ + "id", + "name", + "description", + "manoServiceInterfaceIds", + "_links" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "description": { + "description": "Human-readable description of the NFV-MANO service.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "manoServiceInterfaceIds": { + "description": "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. See note\n", + "type": "array", + "items": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "minItems": 1 + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "properties": { + "manoServiceInterfaces": { + "description": "Link to the \"individual NFV-MANO service interface\" resources with information about the associated interfaces to the NFV-MANO service.\n", + "type": "array", + "items": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "minItems": 1 + } + }, + "required": [ + "manoServiceInterfaces" + ] + } + } + } + }, + "manoConfigurableParams": { + "description": "# Warning: No definition found in the document ManoConfigurableParams\n" + }, + "manoApplicationState": { + "description": "Information and current values of the NFV-MANO functional entityΓÇÖs application state. \n", + "type": "object", + "required": [ + "operationalState", + "administrativeState", + "usageState" + ], + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + } + } + }, + "nfvoSpecificInfo": { + "description": "This type represents information attributes specific to an NFVO entity, and that can be relevant to more than one NFV-MANO service offered by an NFVO entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined.\n", + "type": "object", + "required": [ + "supportedVnfdFormats", + "supportedNsdFormats" + ], + "properties": { + "maxOnboardedNsdNum": { + "description": "Maximum number of NSDs that can be on-boarded on the NFVO. See note 2.\n", + "type": "integer" + }, + "maxOnboardedVnfPkgNum": { + "description": "Maximum number of VNF Packages that can be on-boarded on the NFVO. See note 2.\n", + "type": "integer" + }, + "supportedVnfdFormats": { + "description": "Supported VNFD data formats.\n", + "type": "object", + "properties": { + "vnfdFormat": { + "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + } + }, + "required": [ + "vnfdFormat", + "standardVersion" + ] + }, + "supportedNsdFormats": { + "description": "Supported NSD data formats.\n", + "type": "object", + "properties": { + "nsdFormat": { + "description": "Name of the NSD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + } + }, + "required": [ + "nsdFormat", + "standardVersion" + ] + } + } + }, + "vnfmSpecificInfo": { + "description": "This type represents information attributes specific to a VNFM entity, and that can be relevant to more than one NFV-MANO service offered by a VNFM entity. * NOTE:\tThe information to be provided in this attribute shall relate to the specification and version\n of the specification. For instance, \"ETSI GS NFV-SOL 001 (V2.5.1)\".\n", + "type": "object", + "required": [ + "resoruceMgmtModeSupport", + "managedVnfInstanceInfos", + "supportedVnfdFormats" + ], + "properties": { + "resoruceMgmtModeSupport": { + "description": "The supported resource management modes of the VNFM.\nPermitted values:\n - DIRECT: The VNFM supports direct mode only.\n - INDIRECT: The VNFM supports indirect mode only.\n - BOTH: The VNFM supports both direct and indirect mode.\n", + "type": "string", + "enum": [ + "DIRECT", + "INDIRECT", + "BOTH" + ] + }, + "managedVnfInstanceInfos": { + "description": "The kinds of VNF instances that can be managed, e.g. to determine the compatibility of a VNF with certain VNFM according to the vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011).\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + }, + "supportedVnfdFormats": { + "description": "Supported VNFD data formats.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "vnfdFormat": { + "description": "Name of the VNFD format.\nPermitted values:\n - TOSCA: The VNFD follows TOSCA definition, according to ETSI \n GS NFV-SOL 001 standard.\n - YANG: The VNFD follows YANG definition according to ETSI \n GS NFV-SOL 006 standard.\n", + "type": "string", + "enum": [ + "TOSCA", + "YANG" + ] + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + } + }, + "required": [ + "vnfdFormat", + "standardVersion" + ] + }, + "minItems": 1 + } + } + }, + "vimSpecificInfo": { + "description": "This type represents information attributes specific to a VIM entity, and that can be relevant to more than one NFV-MANO service offered by a VIM entity.\n", + "type": "object" + }, + "wimSpecificInfo": { + "description": "This type represents information attributes specific to a WIM entity, and that can be relevant to more than one NFV MANO service offered by a WIM entity.\n", + "type": "object", + "required": [ + "maxMscsNums", + "maxMsncNum", + "mscsLayerProtocolSupport" + ], + "properties": { + "maxMscsNums": { + "description": "Maximum number of MSCS that the WIM can manage.\n", + "type": "object", + "required": [ + "numMscs" + ], + "properties": { + "numMscs": { + "description": "Maximum number of MSCS.\n", + "type": "integer" + }, + "criteriaNumMscs": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } + }, + "maxMsncNum": { + "description": "Maximum number of MSNC that the WIM can manage\n", + "type": "object", + "required": [ + "numMsnc" + ], + "properties": { + "numMsnc": { + "description": "Maximum number of MSNC..\n", + "type": "integer" + }, + "criteriaNumMsnc": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } + }, + "mscsLayerProtocolSupport": { + "description": "List of protocols of particular layers used to realize an MSCS that are supported by the WIM.\nPermitted values:\n - EVPN_BGP_MPLS: L2 MSCS realized by BGP MPLS-based Ethernet VPN (EVPN) as specified in IETF RFC 7432.\n - EVPN_VPWS: L2 MSCS realized by EVPN Virtual Private Wire Service (VPWS) as specified in IETF RFC 8214.\n - VPLS_BGP: L2 MSCS realized by Virtual Private LAN Service (VPLS) using BGP as specified\n in IETF RFC 4761 and IETF RFC.\n - VPLS_LDP_L2TP: L2 MSCS realized by VPLS using Label Distribution Protocol (LDP) Layer 2\n Tunnelling Protocol (L2TP) as specified in IETF RFC 4762 and IETF RFC 6074.\n - VPWS_LDP_L2TP: L2 MSCS realized by VPWS using LDP L2TP as specified in IETF RFC 6074.\n - BGP_IP_VPN: L3 MSCS realized by BGP/MPLS based IP VPN as specified in IETF RFC 4364.\n", + "type": "string", + "enum": [ + "EVPN_BGP_MPLS", + "EVPN_VPWS", + "VPLS_BGP", + "VPLS_LDP_L2TP", + "VPWS_LDP_L2TP", + "BGP_IP_VPN" + ] + } + } + }, + "_links": { + "description": "Links to resources related to this resource.\n", + "type": "object", + "required": [ + "self", + "manoServiceInterfaces", + "peerEntities", + "changeState", + "changeStateOpOccs" + ], + "properties": { + "self": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "manoServiceInterfaces": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "peerEntities": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "changeState": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "changeStateOpOccs": { + "description": "This type represents a link to a resource using an absolute URI.\n", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + } + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.schema.json index bcedca867..94ea56821 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterface.schema.json @@ -1,215 +1,215 @@ -{ - "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", - "type": "object", - "required": [ - "id", - "name", - "type", - "standardVersion", - "providerSpecificApiVersion", - "apiVersion", - "apiEndpoint", - "supportedOperations", - "interfaceState" - ], - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "providerSpecificApiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Exposed API endpoint of the interface.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "apiUri" - ] - }, - "maxConcurrentIntOpNumber": { - "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", - "type": "integer" - }, - "supportedOperations": { - "description": "Information about supported operations of this interface.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "operationName": { - "description": "Name of the operation supported on the interface.\n", - "type": "string" - }, - "maxConcurrentOpNumber": { - "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", - "type": "integer" - } - }, - "required": [ - "operationName" - ] - }, - "minItems": 1 - }, - "interfaceState": { - "description": "State of the NFV-MANO service interface.\n", - "properties": { - "operationalState": { - "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } - }, - "required": [ - "operationalState", - "administrativeState", - "usageState" - ] - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ], - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "tlsTunnelCipherSuites" - ] - } - } - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } +{ + "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "providerSpecificApiVersion", + "apiVersion", + "apiEndpoint", + "supportedOperations", + "interfaceState" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "providerSpecificApiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Exposed API endpoint of the interface.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + }, + "required": [ + "apiUri" + ] + }, + "maxConcurrentIntOpNumber": { + "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", + "type": "integer" + }, + "supportedOperations": { + "description": "Information about supported operations of this interface.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "operationName": { + "description": "Name of the operation supported on the interface.\n", + "type": "string" + }, + "maxConcurrentOpNumber": { + "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", + "type": "integer" + } + }, + "required": [ + "operationName" + ] + }, + "minItems": 1 + }, + "interfaceState": { + "description": "State of the NFV-MANO service interface.\n", + "properties": { + "operationalState": { + "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + } + }, + "required": [ + "operationalState", + "administrativeState", + "usageState" + ] + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } + } + }, + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.schema.json index 696a8c11e..26199703f 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaceModifications.schema.json @@ -1,105 +1,105 @@ -{ - "description": "This type represents attribute modifications that were performed on an Individual NFV-MANO service interface\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoServiceInterfaceModificationRequest\" data structure. If applicable, additional attributes of the \"ManoServiceInterface\" data structure that were modified implicitly shall also be provided. * NOTE:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all\n to the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided\n in a response message.\n", - "type": "object", - "properties": { - "name": { - "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoServiceInterface\", as defined in clause 5.6.2.11.\n", - "type": "string" - }, - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ], - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "tlsTunnelCipherSuites" - ] - } - } - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } +{ + "description": "This type represents attribute modifications that were performed on an Individual NFV-MANO service interface\" resource. The attributes that can be included consist of those requested to be modified explicitly in the \"ManoServiceInterfaceModificationRequest\" data structure. If applicable, additional attributes of the \"ManoServiceInterface\" data structure that were modified implicitly shall also be provided. * NOTE:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all\n to the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided\n in a response message.\n", + "type": "object", + "properties": { + "name": { + "description": "If present, this attribute signals modifications of the \"name\" attribute in \"ManoServiceInterface\", as defined in clause 5.6.2.11.\n", + "type": "string" + }, + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } + } + }, + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.schema.json index 5ba68faae..8b6194d71 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/ManoServiceInterfaces.schema.json @@ -1,218 +1,218 @@ -{ - "type": "array", - "items": { - "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", - "type": "object", - "required": [ - "id", - "name", - "type", - "standardVersion", - "providerSpecificApiVersion", - "apiVersion", - "apiEndpoint", - "supportedOperations", - "interfaceState" - ], - "properties": { - "id": { - "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "providerSpecificApiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Exposed API endpoint of the interface.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "apiUri" - ] - }, - "maxConcurrentIntOpNumber": { - "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", - "type": "integer" - }, - "supportedOperations": { - "description": "Information about supported operations of this interface.\n", - "type": "array", - "items": { - "type": "object", - "properties": { - "operationName": { - "description": "Name of the operation supported on the interface.\n", - "type": "string" - }, - "maxConcurrentOpNumber": { - "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", - "type": "integer" - } - }, - "required": [ - "operationName" - ] - }, - "minItems": 1 - }, - "interfaceState": { - "description": "State of the NFV-MANO service interface.\n", - "properties": { - "operationalState": { - "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - }, - "usageState": { - "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", - "type": "string", - "enum": [ - "IN_USE", - "NOT_IN_USE" - ] - } - }, - "required": [ - "operationalState", - "administrativeState", - "usageState" - ] - }, - "securityInfo": { - "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "required": [ - "providedConfiguration", - "tlsCipherSuites" - ], - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "tlsTunnelCipherSuites" - ] - } - } - }, - "metadata": { - "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", - "type": "object" - } - } - } +{ + "type": "array", + "items": { + "description": "This type represents an individual NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and\n version of the specification. For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tIf this attribute is not present, the value of this parameter is undefined. Overload is\n handled by the error handling schemes defined by the applicable API specification.\n* NOTE 3:\tDue to the security sensitive information associated to the attribute, based on access\n control policies, the API consumer might have read only, write only, read/write, or no access\n at all to the attribute's value. In case the API consumer is not allowed to read the value of\n the security sensitive attribute, the attribute shall be omitted when the information is to be\n provided in a response message, and shall be provided otherwise. In case the API consumer is\n not allowed to modify the value of the security sensitive attribute, and the modification request\n includes new attribute values, the whole modification request shall be rejected, and proper\n error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "providerSpecificApiVersion", + "apiVersion", + "apiEndpoint", + "supportedOperations", + "interfaceState" + ], + "properties": { + "id": { + "description": "An identifier that is unique for the respective type within a NFV-MANO functional entity, but that need not be globally unique. Representation: string of variable length..\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the NFV-MANO functional entity interface.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface produced by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "providerSpecificApiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Exposed API endpoint of the interface.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + }, + "required": [ + "apiUri" + ] + }, + "maxConcurrentIntOpNumber": { + "description": "Maximum number of concurrent operation requests supported on this interface. See note 2.\n", + "type": "integer" + }, + "supportedOperations": { + "description": "Information about supported operations of this interface.\n", + "type": "array", + "items": { + "type": "object", + "properties": { + "operationName": { + "description": "Name of the operation supported on the interface.\n", + "type": "string" + }, + "maxConcurrentOpNumber": { + "description": "Maximum number of concurrent requests supported by the interface operation. See note 2.\n", + "type": "integer" + } + }, + "required": [ + "operationName" + ] + }, + "minItems": 1 + }, + "interfaceState": { + "description": "State of the NFV-MANO service interface.\n", + "properties": { + "operationalState": { + "description": "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + }, + "usageState": { + "description": "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n", + "type": "string", + "enum": [ + "IN_USE", + "NOT_IN_USE" + ] + } + }, + "required": [ + "operationalState", + "administrativeState", + "usageState" + ] + }, + "securityInfo": { + "description": "This type represents security related information of an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API producer.\nThe support of authorization methods for the API producer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values:\n - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246.\n - OAUTH2: Using access token, as defined by the OAuth 2.0 specification \n in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "required": [ + "providedConfiguration", + "tlsCipherSuites" + ], + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API producer when performing the SSL or TLS negotiation with the API client. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "tlsTunnelCipherSuites" + ] + } + } + }, + "metadata": { + "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 pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n", + "type": "object" + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.schema.json index 75811a050..2e02794be 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.schema.json @@ -1,212 +1,212 @@ -{ - "type": "array", - "items": { - "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", - "type": "object", - "required": [ - "id", - "peerEntityId", - "name", - "type", - "peerEntityState" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "peerEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM", - "WIM", - "EM", - "OSS", - "WIM" - ] - }, - "description": { - "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "consumedManoInterfaces": { - "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", - "type": "object", - "additionalProperties": { - "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", - "type": "object", - "required": [ - "id", - "name", - "type", - "standardVersion", - "apiVersion", - "apiEndpoint" - ], - "properties": { - "name": { - "description": "Human-readable name of the NFV-MANO interface.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "apiUri" - ] - }, - "securityInfo": { - "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - } - } - } - } - } - }, - "peerEntityState": { - "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", - "type": "object", - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - } - }, - "required": [ - "operationalState", - "administrativeState" - ] - } - } - } +{ + "type": "array", + "items": { + "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", + "type": "object", + "required": [ + "id", + "peerEntityId", + "name", + "type", + "peerEntityState" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "peerEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM", + "EM", + "OSS", + "WIM" + ] + }, + "description": { + "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "consumedManoInterfaces": { + "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "apiVersion", + "apiEndpoint" + ], + "properties": { + "name": { + "description": "Human-readable name of the NFV-MANO interface.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + }, + "required": [ + "apiUri" + ] + }, + "securityInfo": { + "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", + "type": "string", + "format": "uri" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", + "type": "string", + "format": "uri" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + } + } + } + } + } + }, + "peerEntityState": { + "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", + "type": "object", + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + } + }, + "required": [ + "operationalState", + "administrativeState" + ] + } + } + } } \ No newline at end of file diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.schema.json similarity index 98% rename from SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json rename to SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.schema.json index e168b2a11..67233fbbb 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.json +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.schema.json @@ -1,209 +1,209 @@ -{ - "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", - "type": "object", - "required": [ - "id", - "peerEntityId", - "name", - "type", - "peerEntityState" - ], - "properties": { - "id": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "peerEntityId": { - "description": "An identifier with the intention of being globally unique.\n", - "type": "string" - }, - "name": { - "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "type": { - "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", - "type": "string", - "enum": [ - "NFVO", - "VNFM", - "VIM", - "WIM", - "EM", - "OSS", - "WIM" - ] - }, - "description": { - "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", - "type": "string" - }, - "consumedManoInterfaces": { - "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", - "type": "object", - "additionalProperties": { - "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", - "type": "object", - "required": [ - "id", - "name", - "type", - "standardVersion", - "apiVersion", - "apiEndpoint" - ], - "properties": { - "name": { - "description": "Human-readable name of the NFV-MANO interface.\n", - "type": "string" - }, - "type": { - "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", - "type": "string" - }, - "standardVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiVersion": { - "description": "A version.\n", - "type": "string" - }, - "apiEndpoint": { - "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", - "type": "object", - "properties": { - "apiRoot": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - }, - "apiName": { - "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiMajorVersion": { - "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", - "type": "string" - }, - "apiUri": { - "description": "String formatted according to IETF RFC 3986.\n", - "type": "string" - } - }, - "required": [ - "apiUri" - ] - }, - "securityInfo": { - "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", - "type": "object", - "required": [ - "authType", - "oauthServerInfo" - ], - "properties": { - "authType": { - "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TLS_TUNNEL", - "OAUTH2" - ] - }, - "minItems": 1 - }, - "oauthServerInfo": { - "description": "OAuth 2.0 authorization server information and configuration.\n", - "type": "object", - "properties": { - "dynamicDiscovery": { - "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "webFingerHost" - ], - "properties": { - "webFingerHost": { - "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "providedConfiguration": { - "description": "Configuration data used to setup the authorization server identifier. See note.\n", - "type": "object", - "required": [ - "authServerId" - ], - "properties": { - "authServerId": { - "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", - "type": "string", - "format": "uri" - } - } - }, - "tlsCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - }, - "tlsTunnelInfo": { - "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", - "type": "object", - "properties": { - "tlsTunnelCipherSuites": { - "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", - "type": "array", - "items": { - "type": "string", - "minItems": 1 - } - } - } - } - } - } - } - } - }, - "peerEntityState": { - "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", - "type": "object", - "properties": { - "operationalState": { - "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", - "type": "string", - "enum": [ - "STARTED", - "STOPPED", - "STOPPING", - "STARTING", - "RESTARTING" - ] - }, - "administrativeState": { - "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", - "type": "string", - "enum": [ - "LOCKED", - "UNLOCKED", - "LOCKING" - ] - } - }, - "required": [ - "operationalState", - "administrativeState" - ] - } - } +{ + "description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n", + "type": "object", + "required": [ + "id", + "peerEntityId", + "name", + "type", + "peerEntityState" + ], + "properties": { + "id": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "peerEntityId": { + "description": "An identifier with the intention of being globally unique.\n", + "type": "string" + }, + "name": { + "description": "Human-readable name of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "type": { + "description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n", + "type": "string", + "enum": [ + "NFVO", + "VNFM", + "VIM", + "WIM", + "EM", + "OSS", + "WIM" + ] + }, + "description": { + "description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n", + "type": "string" + }, + "consumedManoInterfaces": { + "description": "Information of the interface consumed by the NFV-MANO functional entity from the peer functional entity.\nThis attribute can be modified with the PATCH method.\nThe keys of the map, each of which identifies information about a particular consumed NFV-MANO interface, are managed by the API consumer and referenced from other data structures via the \"consumedManoInterfaceIds\" attribute.\n", + "type": "object", + "additionalProperties": { + "description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n", + "type": "object", + "required": [ + "id", + "name", + "type", + "standardVersion", + "apiVersion", + "apiEndpoint" + ], + "properties": { + "name": { + "description": "Human-readable name of the NFV-MANO interface.\n", + "type": "string" + }, + "type": { + "description": "Type of the NFV-MANO service interface consumed by the NFV-MANO functional entity. Valid values are defined in clause 5.6.4.3.\n", + "type": "string" + }, + "standardVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiVersion": { + "description": "A version.\n", + "type": "string" + }, + "apiEndpoint": { + "description": "Consumable API endpoint of the interface. It provides the information relevant about the protocol, host and port, and path where the interface API can be accessed.\n", + "type": "object", + "properties": { + "apiRoot": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + }, + "apiName": { + "description": "Indicates the interface name in an abbreviated form. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The {apiName} of each interface is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiMajorVersion": { + "description": "Indicates the current major version of the API. Shall be present for ETSI NFV specified RESTful NFV-MANO APIs. The major version is defined in the standard the interface is compliant to (see also clause 4.1 of ETSI GS NFV-SOL 013). May be present otherwise.\n", + "type": "string" + }, + "apiUri": { + "description": "String formatted according to IETF RFC 3986.\n", + "type": "string" + } + }, + "required": [ + "apiUri" + ] + }, + "securityInfo": { + "description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n", + "type": "object", + "required": [ + "authType", + "oauthServerInfo" + ], + "properties": { + "authType": { + "description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749. \n", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TLS_TUNNEL", + "OAUTH2" + ] + }, + "minItems": 1 + }, + "oauthServerInfo": { + "description": "OAuth 2.0 authorization server information and configuration.\n", + "type": "object", + "properties": { + "dynamicDiscovery": { + "description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "webFingerHost" + ], + "properties": { + "webFingerHost": { + "description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n", + "type": "string", + "format": "uri" + } + } + }, + "providedConfiguration": { + "description": "Configuration data used to setup the authorization server identifier. See note.\n", + "type": "object", + "required": [ + "authServerId" + ], + "properties": { + "authServerId": { + "description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n", + "type": "string", + "format": "uri" + } + } + }, + "tlsCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the authorization server. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + }, + "tlsTunnelInfo": { + "description": "Information and configuration related to the use of TLS tunnel. Shall be present if authType contains \"TLS_TUNNEL\".\n", + "type": "object", + "properties": { + "tlsTunnelCipherSuites": { + "description": "List of cipher suites that shall be declared as supported by the API consumer when performing the SSL or TLS negotiation with the API producer. Valid values of cipher suites are defined in IETF RFC 8447.\n", + "type": "array", + "items": { + "type": "string", + "minItems": 1 + } + } + } + } + } + } + } + } + }, + "peerEntityState": { + "description": "State of the peer functional entity as provided by the API consumer when creating the resource or when updating it with the PATCH method.\n", + "type": "object", + "properties": { + "operationalState": { + "description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n", + "type": "string", + "enum": [ + "STARTED", + "STOPPED", + "STOPPING", + "STARTING", + "RESTARTING" + ] + }, + "administrativeState": { + "description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n", + "type": "string", + "enum": [ + "LOCKED", + "UNLOCKED", + "LOCKING" + ] + } + }, + "required": [ + "operationalState", + "administrativeState" + ] + } + } } \ No newline at end of file -- GitLab From ab3632d4a7449b92727c21fecb1f4ac49115a0db Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Wed, 13 Oct 2021 17:23:47 +0500 Subject: [PATCH 18/22] update applicability description for POST subscription - unprocessable entity --- .../Subscriptions.robot | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 4cb9a4901..3680ae513 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -180,7 +180,7 @@ POST Create a new subscription - Unprocessable Entity ... Pre-conditions: none ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO - ... Applicability: none + ... Applicability: Notification endpoint test by NFV-MANO fails. ... Post-Conditions: none Send Post Request for Subscription with Unreachable callbackUri Check HTTP Response Status Code Is 422 -- GitLab From da2778a4c11b9d3e858f9037d7553dda729cb444 Mon Sep 17 00:00:00 2001 From: hammad zafar Date: Wed, 13 Oct 2021 17:54:48 +0500 Subject: [PATCH 19/22] removed unused OpenAPI yaml --- .../NFVMANOCimKeywords.robot | 1 + ...onfigurationInformationManagement-API.yaml | 33445 ---------------- .../Subscriptions.robot | 4 +- 3 files changed, 3 insertions(+), 33447 deletions(-) delete mode 100644 SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot index cb1eb6210..a88658791 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot @@ -676,6 +676,7 @@ Send Post Request for Subscription ... Check Notification Endpoint Send Post Request for Subscription with Unreachable callbackUri + Log Trying to create a subscription for an unreachable Notification Endpoint Set headers {"Content-Type": "${CONTENT_TYPE_JSON}"} Set headers {"Accept": "${ACCEPT_JSON}"} Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": ${AUTHORIZATION}"} diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml b/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml deleted file mode 100644 index 3fed77a90..000000000 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/SOL009-NFVMANOConfigurationInformationManagement-API.yaml +++ /dev/null @@ -1,33445 +0,0 @@ -openapi: 3.0.2 -info: - version: '1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1' - title: SOL009 - NFV-MANO Configuration and Information Management Interface - description: > - SOL009 - NFV-MANO Configuration and Information 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' - contact: - name: NFV-SOL WG -externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: >- - https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf -servers: - - url: 'http://0.0.0.0/nfvmanocim/v1' - description: | - API HTTP Server - - url: 'https://0.0.0.0/nfvmanocim/v1' - description: | - API HTTPS Server -paths: - /api_versions: - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: false - schema: - type: string - - name: Authorization - description: 'The authorization token for the request. Reference: IETF RFC 7235' - in: header - required: false - schema: - type: string - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow - the provisions specified in table 4.6.3.3.3.2-1 for request and response - data structures, and response codes. URI query parameters are not - supported. - responses: - '200': - description: > - 200 OK - - API version information was read successfully. The response body - shall contain 4.4 API version information, as defined in clause - 4.4.1.13. - content: - application/json: - schema: - description: | - This type represents API version information. - type: object - required: - - uriPrefix - - apiVersions - properties: - uriPrefix: - description: > - Specifies the URI prefix for the API, in the following - form {apiRoot}/{apiName}/{apiMajorVersion}/. - type: string - apiVersions: - description: > - Version(s) supported for the API signaled by the uriPrefix - attribute. - type: array - items: - type: object - required: - - version - properties: - version: - description: > - Identifies a supported version. The value of the - version attribute shall be a version identifier as - specified in clause 9.1 (SOL013). - type: string - isDeprecated: - description: > - If such information is available, this attribute - indicates whether use of the version signaled by the - version attribute is deprecated (true) or not - (false). - - A deprecated version is still supported by the API - producer but is recommended not to be used any - longer. When a version is no longer supported, it - does not appear in the response body. - type: boolean - retirementDate: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - schema: - type: string - maximum: 1 - minimum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '413': - description: > - 413 PAYLOAD TOO LARGE - - If the payload body of a request is larger than the amount of data - the API producer is willing or able to process, it shall respond - with this response code, following the provisions in IETF RFC 7231 - for the use of the "Retry-After" HTTP header and for closing the - connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '414': - description: > - 414 URI TOO LONG - - If the request URI of a request is longer than the API producer is - willing or able to process, it shall respond with this response - code. This condition can e.g. be caused by passing long queries in - the request URI of a GET request. The "ProblemDetails" structure may - be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '416': - description: | - 416 Range Not Satisfiable - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '429': - description: > - 429 TOO MANY REQUESTS - - If the API consumer has sent too many requests in a defined period - of time and the API producer is able to detect that condition ("rate - limiting"), the API producer shall respond with this response code, - following the provisions in IETF RFC 6585 [17] for the use of the - "Retry-After" HTTP header. The "ProblemDetails" structure shall be - provided and shall include in the "detail" attribute more - information about the source of the problem. - - The period of time and allowed number of requests are configured - within the API producer by means outside the scope of the present - document. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity: - get: - description: > - Retrives information about an NFV-MANO functional entity by reading the - NFV-MANO entity resource. This method shall follow the provisions - specified in the tables 5.5.3.3.2-1 and 5.5.3.3.2-2 for URI query - parameters, request and response data structures, and response - codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when configuration and information about the - NFV-MANO functional entity has been read successfully. The response - body shall contain a representation of the NFV-MANO functional - entity, as defined in clause 5.6.2.2. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: > - Human-readable description of the NFV-MANO functional - entity. - - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional - entity. It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional - entity. $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component - realizing part of an NFV-MANO functional entity. It is - optional for the API producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on - the NFV-MANO functional entity component. The - identifier of the ManoService is referred. A - service may depend on multiple components. Multiple - services may depend on the same component. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the - NFV-MANO functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO - service provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO service. - - This attribute can be modified with the PATCH - method. - type: string - description: - description: > - Human-readable description of the NFV-MANO service. - - This attribute can be modified with the PATCH - method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service - interface" resources with information about the - associated interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource - using an absolute URI. - type: object - required: - - href - properties: - href: - description: > - String formatted according to IETF RFC - 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional - entity’s application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an - NFVO entity, and that can be relevant to more than one - NFV-MANO service offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of - this parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded - on the NFVO. - - NOTE: If this attribute is not present, the value of - this parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a - VNFM entity, and that can be relevant to more than one - NFV-MANO service offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. - to determine the compatibility of a VNF with certain - VNFM according to the vnfmInfo attribute in the VNFD - (see table 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a - VIM entity, and that can be relevant to more than one - NFV-MANO service offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies the NFV-MANO entity resource. Changes to the various - configuration and information attributes are applied to the NFV-MANO - functional entity, and are reflected in the representation of this - resource. This method shall follow the provisions specified in the - tables 5.5.3.3.4-1 and 5.5.3.3.4-2 for URI query parameters, request - and response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the NFV-MANO configuration and information - modification, as defined in clause 5.6.2.3. The Content-Type header - shall be set to "application/merge-patch+json" according to IETF RFC - 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute - array in the "ManoEntityConfigurableParams", as defined - below this table. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case - of an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the - "clockSyncs" attribute array in the - "ManoEntityConfigurableParams", as defined below this - table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" - attribute array in the "ManoEntity", as defined below this - table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the modification of configuration on the - NFV-MANO functional entity has been accepted and completed. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on the "NFV-MANO entity" resource of the producer - NFV-MANO functional entity. The attributes that can be - included consist of those requested to be modified explicitly - in the "ManoConfigModificationRequest" data structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoEntity", as defined in clause - 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in - clause 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", - as defined in clause 5.6.2.3. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock - synchronization. Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case - of an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 - address, string that consists of groups of zero - to four hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as - an object. It shall comply with the provisions - defined in clause 4 of IETF RFC 8259. In the - following example, a list of key-value pairs with - four keys ("aString", "aNumber", "anArray" and - "anObject") is provided to illustrate that the - values associated with different keys can be of - different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of - certain entries in "clockSyncs" attribute in - "ManoEntityConfigurableParams", as defined in clause - 5.6.2.3. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as - defined in clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - name: - description: > - If present, this attribute signals modification of - the "name" attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of - the "description" attribute in the "ManoService". - type: string - required: - - id - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "NFV-MANO entity" resource. - - Typically, this is due to the fact that another configuration and - information modification is ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity/change_state: - post: - description: > - Requests to change the state of the NFV-MANO functional entity - application. - - This method shall follow the provisions specified in the tables - 5.5.7.3.1-1 and 5.5.7.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state - of a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - responses: - '202': - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "Individual change state - operation occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the - error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /mano_entity/mano_interfaces: - get: - description: > - Queries information about multiple NFV-MANO service interfaces of the - NFV-MANO functional entity. This method shall follow the provisions - specified in the tables 5.5.10.3.2-1 and 5.5.10.3.2-2 for URI query - parameters, request and response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the ManoServiceInterface and in - data types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ManoServiceInterface structure in the response body if this - parameter is provided, or none of the parameters "all_fields," - "fields", "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about zero or more NFV-MANO - service interfaces has been queried successfully. - - The response body shall contain in an array the representations of - zero or more NFV-MANO service interfaces, as defined in clause - 5.6.2.11. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents an individual NFV-MANO service - interface produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: > - Information about supported operations of this - interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing - the SSL or TLS negotiation with the API client. - Valid values of cipher suites are defined in - IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/mano_entity/mano_interfaces/{manoServiceInterfaceId}': - parameters: - - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - retrieves information about an NFV-MANO service interface of the - producer NFV-MANO functional entity by reading an "Individual NFV-MANO - service interface" resource. - - This method shall follow the provisions specified in the tables - 5.5.11.3.2-1 and 5.5.11.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual NFV-MANO - service interface has been read successfully. - - The response body shall contain a representation of the NFV-MANO - service interface, as defined in clause 5.6.2.11. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant to - (see also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall - be present for ETSI NFV specified RESTful NFV-MANO - APIs. The major version is defined in the standard - the interface is compliant to (see also clause 4.1 of - ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It - shall comply with the provisions defined in clause 4 of - IETF RFC 8259. In the following example, a list of - key-value pairs with four keys ("aString", "aNumber", - "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of - different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies an "Individual NFV-MANO service interface" resource. - - Changes to the configurable parameters of the corresponding NFV-MANO - service interface are applied to the information managed by the - producer NFV-MANO functional entity and reflected in the representation - of this resource. - - This method shall follow the provisions specified in the tables - 5.5.11.3.4-1 and 5.5.11.3.4-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the modification of configuration parameters of the - NFV-MANO service interface, as defined in clause 5.6.2.12. - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer - NFV-MANO functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual NFV-MANO service interface" - resource, as defined in clause 5.6.2.13. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on an Individual NFV-MANO service interface" - resource. The attributes that can be included consist of - those requested to be modified explicitly in the - "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the - "ManoServiceInterface" data structure that were modified - implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoServiceInterface", as defined in - clause 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the - API producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It - shall comply with the provisions defined in clause 4 of - IETF RFC 8259. In the following example, a list of - key-value pairs with four keys ("aString", "aNumber", - "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of - different type. - type: object - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual NFV-MANO service interface" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/mano_entity/mano_interfaces/{manoServiceInterfaceId}/change_state': - parameters: - - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - post: - description: > - Requests to change the state of the NFV-MANO service interface produced - by the NFV-MANO functional entity. - - This method shall follow the provisions specified in the tables - 5.5.12.3.1-1 and 5.5.12.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state - of a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - responses: - '202': - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for - processing. - - The response body shall be empty. - - The HTTP response shall include a “Location” HTTP header that - contains the URI of the newly-created "Individual change state - operation occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the - error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /subscriptions: - post: - description: > - Creates a new subscription. - - This method shall follow the provisions specified in the tables - 5.5.4.3.1-1 and 5.5.4.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Details of the subscription to be created, as defined in clause - 5.6.2.5-1. - content: - application/json: - schema: - description: > - This type represents a subscription request related to - notifications about NFV-MANO configuration and information - management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their associated - managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference to - NFV-MANO services in a filter. They should not be - used together in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed in - this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed in - this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization - which 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The clientId and - clientPassword passed in a subscription shall not be - the same as the clientId and clientPassword that are - used to obtain authorization for API requests. - Client credentials may differ between subscriptions. - The value of clientPassword should be generated by a - random process. - 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. The clientId and - clientPassword passed in a subscription shall not be - the same as the clientId and clientPassword that are - used to obtain authorization for API requests. - Client credentials may differ between subscriptions. - The value of clientPassword should be generated by a - random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when the subscription has been created - successfully. - - The response body shall contain a representation of the created - "Individual subscription" resource. - - The HTTP response shall include a "Location" HTTP header that - points to the created "Individual subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual subscription" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference - to NFV-MANO services in a filter. They should not - be used together in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed - in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed - in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '303': - description: > - 303 SEE OTHER - - SShall be returned when a subscription with the same callbackURI - and the same filter already exists and the policy of NFV-MANO - functional entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that - contains the resource URI of the existing "Individual subscription" - resource. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual subscription" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: > - queries the list of active subscriptions of the API consumer that - invokes the method. It can be used, e.g., for resynchronization after - error situations. - - This method shall follow the provisions specified in the tables - 5.5.4.3.2-1 and 5.5.4.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the CimSubscription and in data - types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations of - all active subscriptions of the functional block that invokes the - method, i.e., zero or more representations of NFV-MANO - configuration and information management subscriptions as defined - in clause 5.6.2.6. - - If the "filter" URI parameter was supplied in the request, the data - in the response body shall have been transformed according to the - rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being - globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the - respective type within a NFV-MANO functional - entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to - reference to NFV-MANO services in a filter. They - should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity - produced interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the - respective type within a NFV-MANO functional - entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity - produced interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives - to reference to NFV-MANO functional entity - consumed interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives - to reference to NFV-MANO functional entity - consumed interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/subscriptions/{subscriptionId}': - parameters: - - name: subscriptionId - in: path - description: Identifier of the subscription - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - Retrieves information about a subscription by reading an "Individual - subscription" resource. - - This method shall follow the provisions specified in the tables - 5.5.5.3.2-1 and 5.5.5.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual subscription - has been read successfully. - - The response body shall contain a representation of the "Individual - subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management - changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and - information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference - to NFV-MANO services in a filter. They should not - be used together in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed - in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed - in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: > - Terminates an individual subscription. - - This method shall follow the provisions specified in the tables - 5.5.5.3.5-1 and 5.5.5.3.5-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has - been deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /change_state_ops: - get: - description: > - The API consumer can use the GET method to query status information - about multiple change state operation occurrences. - - This method shall follow the provisions specified in the tables - 5.5.8.3.2-1 and 5.5.8.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the ChangeStateOpOcc and in data - types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ChangeStateOpOcc structure in the response body if this parameter - is provided, or none of the parameters "all_fields," "fields", - "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when status information for zero or more "change - state operation occurrences" has been queried successfully. - - The response body shall contain in an array the status information - about zero or more "Individual change state operation occurrences", - as defined in clause 5.6.2.9. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a - managed object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted - values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request - data type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual - resource, and may be present according to the chosen - attribute selector parameter if this data type is - returned in a response to a query of a container - resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/change_state_ops/{changeStateOpOccId}': - parameters: - - name: changeStateOpOccId - in: path - description: Identifier of the change state operation occurrence - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - The API consumer can use the GET method to retrieve status information - about a change state operation occurrence by reading an "Individual - change state operation occurrence" resource. - - This method shall follow the provisions specified in the tables - 5.5.9.3.2-1 and 5.5.9.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an "Individual change - state operation occurrence" resource has been read successfully. - - The response body shall contain status information about a change - state operation occurrence, as defined in clause 5.6.2.9. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted - values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request - data type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual resource, - and may be present according to the chosen attribute - selector parameter if this data type is returned in a - response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /peer_entities: - post: - description: > - Creates in the producer NFV-MANO functional entity a new peer entity - resource which contains configuration and information with regards to - the peer functional entity. - - This method shall follow the provisions specified in the tables - 5.5.13.3.1-1 and 5.5.13.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: | - The peer entity creation parameters, as defined in clause 5.6.2.14. - content: - application/json: - schema: - description: > - This type represents request parameters for the creation of a - new peer entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when a new "Individual peer entity" resource has - been created successfully. - - The response body shall contain a representation of the created - resource with regards to a peer entity, as defined in clause - 5.6.2.15. - - The HTTP response shall include a “Location” HTTP header that - points to the created "Individual peer entity" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual peer entity" - resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: > - Queries information and configuration in the producer NFV-MANO - functional entity with regards to multiple peer entities. - - This method shall follow the provisions specified in the tables - 5.5.13.3.2-1 and 5.5.13.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the PeerEntity and in data types - referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the PeerEntity - structure in the response body if this parameter is provided, or - none of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about zero or more peer entities - has been queried successfully. - - The response body shall contain in an array the resource - representations of zero or more peer entities, as defined in clause - 5.6.2.15. - - If the “filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - peerEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: > - Human-readable description of the peer functional - entity. - - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the - API. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The major version is - defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used - by the API consumer accessing the API. - - The support of authorization methods for the - API consumer is specified in clause 8.3.6 of - ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC - 5246. - OAUTH2: Using access token, as defined - by the OAuth 2.0 specification in IETF RFC - 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be - declared as supported by the API consumer - when performing the SSL or TLS - negotiation with the authorization server. - Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the - use of TLS tunnel. Shall be present if - authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be - declared as supported by the API consumer - when performing the SSL or TLS negotiation - with the API producer. Valid values of - cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the - API consumer when creating the resource or when - updating it with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/peer_entities/{peerEntityId}': - parameters: - - name: peerEntityId - in: path - description: Identifier of the peer entity - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - Retrieves information and configuration hold in the producer NFV-MANO - functional entity with regards to a peer entity by reading an - individual peer entity resource. - - This method shall follow the provisions specified in the tables - 5.5.14.3.2-1 and 5.5.14.3.2-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual peer - functional entity has been read successfully. - - The response body shall contain a resource representation of the - peer functional entity, as defined in clause 5.6.2.15. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - patch: - description: > - Modifies configuration and information of the producer NFV-MANO - functional entity with regards to a peer functional entity by updating - the corresponding "Individual peer entity" resource. - - Changes to the configurable parameters of the corresponding peer entity - are applied to the information managed by the producer NFV-MANO - functional entity and reflected in the representation of this resource. - - This method shall follow the provisions specified in the tables - 5.5.14.3.4-1 and 5.5.14.3.4-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: > - Parameters for the modification of configuration parameters of the - peer functional entity, as defined in clause 5.6.2.16 - - The Content-Type header shall be set to - "application/merge-patch+json" according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or - "null" to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " - PeerEntity ", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: true - responses: - '200': - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual peer entity" resource, as defined - in clause 5.6.2.17. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were - performed on an "Individual peer entity" resource. The - attributes that can be included consist of those requested to - be modified explicitly in the - "PeerEntityConfigModificationRequest" data structure. If - applicable, additional attributes of the "PeerEntity" data - structure that were modified implicitly shall also be - provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in - clause 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the - producer NFV MANO functional entity from another peer - functional entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by - the NFV-MANO functional entity. Valid values are - defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It - provides the information relevant about the - protocol, host and port, and path where the - interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the - interface is compliant to (see also clause 4.1 - of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information - for accessing an NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI - GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS - tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the - OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as - defined in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the authorization server. Valid values of - cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with - the API producer. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of - certain entries in the "consumedManoInterfaces" attribute - in "PeerEntity", as defined in clause 5.6.2.15. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual peer entity" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: > - Ddeletes an individual peer entity resource. By deleting such a - resource in the producer NFV-MANO functional entity representing a peer - NFV-MANO entity, the configuration and information with regards to such - peer entity is deleted. Consequently, the peering relationship between - the producer NFV-MANO functional entity and the peer entity is - terminated, i.e., the producer NFV-MANO functional entity does not have - the necessary information to communicate/interact with the peer entity. - - This method shall follow the provisions specified in the tables - 5.5.14.3.5-1 and 5.5.14.3.5-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: > - 204 NO CONTENT - - Shall be returned when the "Individual peer entity" resource has - been deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '409': - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the - "Individual peer entity" resource. - - Typically, this is due to the fact that another operation is - ongoing. - - The response body shall contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '412': - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in - an HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in - which the "detail" attribute should convey more information about - the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 -components: - schemas: - ManoEntity: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional entity. - It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional entity. $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component realizing - part of an NFV-MANO functional entity. It is optional for the API - producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the - NFV-MANO functional entity component. The identifier of the - ManoService is referred. A service may depend on multiple - components. Multiple services may depend on the same - component. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the NFV-MANO - functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO service - provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" - resources with information about the associated - interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional entity’s - application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an NFVO - entity, and that can be relevant to more than one NFV-MANO service - offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM - entity, and that can be relevant to more than one NFV-MANO service - offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to - determine the compatibility of a VNF with certain VNFM - according to the vnfmInfo attribute in the VNFD (see table - 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a VIM - entity, and that can be relevant to more than one NFV-MANO service - offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - ManoConfigModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute array - in the "ManoEntityConfigurableParams", as defined below this - table. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the "clockSyncs" - attribute array in the "ManoEntityConfigurableParams", as defined - below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" attribute - array in the "ManoEntity", as defined below this table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - ManoConfigModifications: - description: > - This type represents attribute modifications that were performed on the - "NFV-MANO entity" resource of the producer NFV-MANO functional entity. - The attributes that can be included consist of those requested to be - modified explicitly in the "ManoConfigModificationRequest" data - structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoEntity", as defined in clause 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in clause - 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of certain entries - in "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as defined in - clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - If present, this attribute signals modification of the "name" - attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of the - "description" attribute in the "ManoService". - type: string - required: - - id - CimSubscriptionRequest: - description: > - This type represents a subscription request related to notifications - about NFV-MANO configuration and information management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The - clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are - used to obtain authorization for API requests. Client - credentials may differ between subscriptions. The value of - clientPassword should be generated by a random process. - 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. The - clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are - used to obtain authorization for API requests. Client - credentials may differ between subscriptions. The value of - clientPassword should be generated by a random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - CimSubscription: - description: > - This type represents a subscription related to notifications about - NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - ChangeStateRequest: - description: > - This type represents request parameters for changing the state of a - managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - ChangeStateOpOcc: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according to IETF - RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according to IETF - RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed object of - a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if attribute - "manoEntityComponents" in "ManoEntity" is supported by the API - producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: | - An identifier with the intention of being globally unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This attribute shall - be formatted according to the request data type of the related - change state operation. - - The following mapping between operationType and the data type of - this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is returned in a - response to reading an individual resource, and may be present - according to the chosen attribute selector parameter if this data - type is returned in a response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - ManoServiceInterface: - description: > - This type represents an individual NFV-MANO service interface produced - by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO functional entity interface. - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the NFV-MANO - functional entity. Valid values are defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - {apiName} of each interface is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be present - for ETSI NFV specified RESTful NFV-MANO APIs. The major version - is defined in the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - ManoServiceInterfaceModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer NFV-MANO - functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - ManoServiceInterfaceModifications: - description: > - This type represents attribute modifications that were performed on an - Individual NFV-MANO service interface" resource. The attributes that - can be included consist of those requested to be modified explicitly in - the "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the "ManoServiceInterface" data - structure that were modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoServiceInterface", as defined in clause 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the API client. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - CreatePeerEntityRequest: - description: > - This type represents request parameters for the creation of a new peer - entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO functional - entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - PeerEntity: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO functional - entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API consumer - when creating the resource or when updating it with the PATCH - method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - PeerEntityConfigModificationRequest: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or "null" - to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " PeerEntity ", as - defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - PeerEntityConfigModifications: - description: > - This type represents attribute modifications that were performed on an - "Individual peer entity" resource. The attributes that can be included - consist of those requested to be modified explicitly in the - "PeerEntityConfigModificationRequest" data structure. If applicable, - additional attributes of the "PeerEntity" data structure that were - modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "PeerEntity", as defined in clause 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer NFV - MANO functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and - path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API - consumer accessing the API. - - The support of authorization methods for the API consumer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When - used, the request to the WebFinger resource shall - conform as specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI - GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing the SSL - or TLS negotiation with the API producer. Valid - values of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of certain entries - in the "consumedManoInterfaces" attribute in "PeerEntity", as - defined in clause 5.6.2.15. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - ManoConfigurableParams: - description: | - # Warning: No definition found in the document ManoConfigurableParams - ManoEntityComponent: - description: > - This type represents information of a deployed component realizing part - of an NFV-MANO functional entity. It is optional for the API producer - to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the NFV-MANO - functional entity component. The identifier of the ManoService is - referred. A service may depend on multiple components. Multiple - services may depend on the same component. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - required: - - id - ManoService: - description: > - This type represents information about an NFV-MANO service provided by - the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" resources - with information about the associated interfaces to the - NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an absolute - URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - NfvoSpecificInfo: - description: > - This type represents information attributes specific to an NFVO entity, - and that can be relevant to more than one NFV-MANO service offered by - an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on the NFVO. - - NOTE: If this attribute is not present, the value of this parameter - is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - VnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM entity, - and that can be relevant to more than one NFV-MANO service offered by a - VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to determine - the compatibility of a VNF with certain VNFM according to the - vnfmInfo attribute in the VNFD (see table 7.1.2.2-1 in ETSI GS - NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - VimSpecificInfo: - description: > - This type represents information attributes specific to a VIM entity, - and that can be relevant to more than one NFV-MANO service offered by a - VIM entity. - type: object - ManoEntityConfigurableParams: - description: > - This type represents list of parameters that can be configured on the - NFV MANO functional entity. - type: object - properties: - clockSyncs: - description: >- - Properties of the clock synchronization to be used by the NFV-MANO - functional entity. - type: array - items: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an - IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to - 255. In case of an IPV6 address, string that consists of - groups of zero to four hexadecimal digits, separated by - colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - type - minItems: 1 - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - required: - - clockSyncs - - defaultLogCompileBySizeValue - - defaultLogCompileByTimerValue - ConsumedManoInterfaceInfo: - description: > - This type represents an interface consumed by the producer NFV MANO - functional entity from another peer functional entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the NFV-MANO - functional entity. Valid values are defined in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides the - information relevant about the protocol, host and port, and path - where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - {apiName} of each interface is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be present - for ETSI NFV specified RESTful NFV-MANO APIs. The major version - is defined in the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for accessing an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API consumer - accessing the API. - - The support of authorization methods for the API consumer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by - TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as - defined by the OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When used, - the request to the WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI GS - NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API consumer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API consumer when performing the SSL or TLS negotiation - with the API producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - CimNotificationsFilter: - description: > - This type represents a subscription filter related to notifications - about NFV-MANO configuration and information management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match NFV-MANO - functional entities and their associated managed objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced interfaces - with an instance identifier listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference to - NFV-MANO functional entity produced interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced interfaces - with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference to - NFV-MANO functional entity produced interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed interfaces - with an instance identifier listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference to - NFV-MANO functional entity consumed interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed interfaces - with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference to - NFV-MANO functional entity consumed interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - ClockSyncInfo: - description: | - This type represents parameters for connecting to an NTP server. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. Shall be - present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an IPV4 - address, string that consists of four decimal integers separated - by dots, each integer ranging from 0 to 255. In case of an IPV6 - address, string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 - pairs is represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. In the following - example, a list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to illustrate that - the values associated with different keys can be of different type. - type: object - required: - - id - - type - ServerInterfaceSecurityInfo: - description: > - This type represents security related information of an NFV-MANO - service interface produced by an NFV-MANO functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API producer. - - The support of authorization methods for the API producer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by - the API producer when performing the SSL or TLS negotiation - with the authorization server. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as supported by the - API producer when performing the SSL or TLS negotiation with the - API client. Valid values of cipher suites are defined in IETF - RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - ClientInterfaceSecurityInfo: - description: > - This type represents security related information for accessing an - NFV-MANO service interface produced by an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the API consumer - accessing the API. - - The support of authorization methods for the API consumer is - specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS - 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by - the OAuth 2.0 specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: | - OAuth 2.0 authorization server information and configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is hosted. When used, the - request to the WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined in ETSI GS - NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as supported by the - API consumer when performing the SSL or TLS negotiation with - the authorization server. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS tunnel. - Shall be present if authType contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as supported by the - API consumer when performing the SSL or TLS negotiation with - the API producer. Valid values of cipher suites are defined in - IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - ManoServiceInterfaceTypeShortName: - description: "For the RESTful NFV-MANO APIs, valid values are all values for \"apiName\" as defined in ETSI GS NFV-SOL 002, ETSI GS NFV-SOL 003, and ETSI GS NFV-SOL 005.\nFor the NFV-MANO service interfaces for which no API is specified by ETSI NFV, valid values are defined in table 5.6.4.3-1.\nNOTE:\tThe table is expected to be updated, by removing the corresponding listed entries, once the interfaces are specified as a RESTful NFV-MANO API. \n" - type: string - UsageStateEnumType: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - ChangeOperationalStateEnumType: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - ChangeAdministrativeStateEnumType: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - InterfaceOperationalStateEnumType: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - StopEnumType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - ManoEntityEnumType: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - PeerEntityEnumType: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - parameters: - filter.ManoServiceInterface: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the ManoServiceInterface and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.CimSubscription: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the CimSubscription and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.ChangeStateOpOcc: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the ChangeStateOpOcc and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - filter.PeerEntity: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the PeerEntity and in data types - referenced from it shall be supported by the NFV-MANO functional entity - in the expression. - in: query - required: false - schema: - type: string - exclude_default.ManoServiceInterface: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the - ManoServiceInterface structure in the response body if this parameter - is provided, or none of the parameters "all_fields," "fields", - "exclude_fields", "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.CimSubscription: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the CimSubscription - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.ChangeStateOpOcc: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the ChangeStateOpOcc - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - exclude_default.PeerEntity: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the PeerEntity - structure in the response body if this parameter is provided, or none - of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - manoServiceInterfaceId: - name: manoServiceInterfaceId - in: path - description: Identifier of the MANO service interface. - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - subscriptionId: - name: subscriptionId - in: path - description: Identifier of the subscription - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - changeStateOpOccId: - name: changeStateOpOccId - in: path - description: Identifier of the change state operation occurrence - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - name: peerEntityId - in: path - description: Identifier of the peer entity - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - requestBodies: - ModifyManoEntityRequest: - description: > - Parameters for the NFV-MANO configuration and information modification, - as defined in clause 5.6.2.3. The Content-Type header shall be set to - "application/merge-patch+json" according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO functional entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "ManoEntity". - type: string - description: - description: | - New value of the "description" attribute in "ManoEntity". - type: string - clockSyncs: - description: > - New content of certain entries in the "clockSyncs" attribute - array in the "ManoEntityConfigurableParams", as defined below - this table. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of - an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - List of identifiers entries to be deleted from the - "clockSyncs" attribute array in the - "ManoEntityConfigurableParams", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - New content of certain entries in the "manoServices" attribute - array in the "ManoEntity", as defined below this table. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: "New value for the \"name\" attribute in the \"ManoService\". \nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - description: - description: "New value for the \"description\" attribute in the \"ManoService\".\nNOTE:\tAt least one of these attributes shall be provided if requesting a modification of the NFV-MANO service identified by \"id\".\n" - type: string - required: - - id - required: true - ChangeManoEntityStateRequest: - description: | - Parameters for the change state operation, as defined in clause 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state of - a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - ModifyManoEnityInterfaceRequest: - description: > - Parameters for the modification of configuration parameters of the - NFV-MANO service interface, as defined in clause 5.6.2.12. - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of an NFV-MANO service interface of the producer - NFV-MANO functional entity. - type: object - properties: - name: - description: "New value of the \"name\" attribute in \"ManoServiceInterface\". \nNOTE:\tChanging the name does not change the corresponding standardized API name in the resource URI (refer to \"{apiName}\" defined in clause 4.1 of ETSI GS NFV-SOL 013).\n" - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: true - ChangeManoEntityInterfaceStateRequest: - description: > - Parameters for the change state operation, as defined in clause - 5.6.2.8. - content: - application/json: - schema: - description: > - This type represents request parameters for changing the state of - a managed entity. - type: object - properties: - operationalStateChange: - description: "A change of operational state. Shall be present if the state change request refers to the operational state. NOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - operationalStateAction: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - stopType: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions:\n - GRACEFUL\tTo stop the managed entity immediately after accepting the request.\n - FORCEFUL\tTo stop the managed entity attempting to gracefully discharge the entity from service.\n" - type: string - enum: - - GRACEFUL - - FORCEFUL - gracefulStopTimeout: - description: "The time internal (in seconds) to wait for the entity to be taken out of service during graceful stop. \nNOTE:\tThe \"stopType\" shall only be provided when the \"operationalStateAction\" attribute is equal to \"STOP\" or \"RESTART\". The \"gracefulStopTimeout\" shall be absent when the \"stopType\" attribute is equal to \"FORCEFUL\", and may be provided otherwise.\n" - type: integer - required: - - operationalStateAction - administrativeStateChange: - description: "A change of administrative state. Shall be present if the state change request refers to the administrative state. \nNOTE:\tIn the present document version, a request shall only include an operational state change (attribute \"operationalStateChange\") or an administrative state change request (attribute \"administrativeStateChange\"), but not both.\n" - type: object - properties: - administrativeStateAction: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - required: - - administrativeStateAction - required: true - CimSubscriptionRequest: - description: > - Details of the subscription to be created, as defined in clause - 5.6.2.5-1. - content: - application/json: - schema: - description: > - This type represents a subscription request related to - notifications about NFV-MANO configuration and information - management changes. - type: object - properties: - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which - 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The clientId and clientPassword passed in - a subscription shall not be the same as the clientId - and clientPassword that are used to obtain - authorization for API requests. Client credentials may - differ between subscriptions. The value of - clientPassword should be generated by a random - process. - 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. - The clientId and clientPassword passed in a - subscription shall not be the same as the clientId and - clientPassword that are used to obtain authorization - for API requests. Client credentials may differ - between subscriptions. The value of clientPassword - should be generated by a random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - required: true - CreatePeerEntityRequest: - description: | - The peer entity creation parameters, as defined in clause 5.6.2.14. - content: - application/json: - schema: - description: > - This type represents request parameters for the creation of a new - peer entity resource. - type: object - properties: - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: | - Current values of the state of the peer functional entity. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - peerEntityId - - name - - type - required: true - ModifyPeerEntityRequest: - description: > - Parameters for the modification of configuration parameters of the peer - functional entity, as defined in clause 5.6.2.16 - - The Content-Type header shall be set to "application/merge-patch+json" - according to IETF RFC 7396. - content: - application/merge-patch+json: - schema: - description: > - This type represents attribute modifications for configuration - parameters of a peer entity. - type: object - properties: - name: - description: | - New value of the "name" attribute in "PeerEntity". - type: string - description: - description: > - New value of the "description" attribute in "PeerEntity", or - "null" to remove the attribute. - type: string - consumedManoInterfaces: - description: "New content of certain entries in the \"consumedManoInterfaces\" attribute array in the \"PeerEntity\", as defined below this table. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to modify the value of the security sensitive attribute, and the modification request includes new attribute values, the whole modification request shall be rejected, and proper error information returned.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - List of identifiers entries to be deleted from the - "consumedManoInterfaces" attribute array in the " PeerEntity - ", as defined below this table. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: true - responses: - mano_entity.get.200: - description: > - 200 OK - - Shall be returned when configuration and information about the NFV-MANO - functional entity has been read successfully. The response body shall - contain a representation of the NFV-MANO functional entity, as defined - in clause 5.6.2.2. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an NFV-MANO functional entity. - type: object - required: - - id - - type - - name - - description - - provider - - softwareVersion - - manoConfigurableParams - - manoApplicationState - - _links - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - type: - description: "The enumeration ManoEntityEnumType defines the permitted values to represent NFV-MANO functional entities. It shall comply with the provisions :\n - NFVO\tThe NFV-MANO functional entity is an NFVO.\n - VNFM\tThe NFV-MANO functional entity is a VNFM.\n - VIM\tThe NFV-MANO functional entity is a VIM.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - name: - description: | - Human-readable name of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO functional entity. - This attribute can be modified with the PATCH method. - type: string - provider: - description: > - Information about the provider of the NFV-MANO functional - entity. It typically includes the name of the provider. - type: string - softwareVersion: - description: > - The version of the software of the NFV-MANO functional entity. - $ref: - "../components/SOL009_schemas.yaml#/components/schemas/Version" - manoEntityComponents: - description: "The deployed NFV-MANO functional entity components which realize the NFV-MANO functional entity. \nNOTE:\tIt is optional for the API producer to support the \"manoEntityComponents\" attribute.\n" - type: array - items: - description: > - This type represents information of a deployed component - realizing part of an NFV-MANO functional entity. It is - optional for the API producer to support this type. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - manoServiceIds: - description: > - References to the NFV-MANO services that depend on the - NFV-MANO functional entity component. The identifier of - the ManoService is referred. A service may depend on - multiple components. Multiple services may depend on the - same component. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - id - manoServices: - description: > - Information about the NFV-MANO services provided by the - NFV-MANO functional entity. - type: array - items: - description: > - This type represents information about an NFV-MANO service - provided by the NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: | - Human-readable name of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - description: - description: | - Human-readable description of the NFV-MANO service. - This attribute can be modified with the PATCH method. - type: string - manoServiceInterfaceIds: - description: "Reference to the NFV-MANO interfaces associated to the NFV-MANO service. If cardinality is greater than one, the type of ManoServiceInterface (see clause 5.6.3.3) shall be the same. The identifier of the ManoServiceInterface is referred. \nNOTE:\tA cardinality greater than one supports having different interface versions or apiEndpoints to be used for accessing the same instance of a NFV-MANO service.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - minItems: 1 - _links: - description: | - Links to resources related to this resource. - type: object - properties: - manoServiceInterfaces: - description: > - Link to the "individual NFV-MANO service interface" - resources with information about the associated - interfaces to the NFV-MANO service. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - minItems: 1 - required: - - manoServiceInterfaces - required: - - id - - name - - description - - manoServiceInterfaceIds - - _links - manoConfigurableParams: - description: > - # Warning: No definition found in the document - ManoConfigurableParams - manoApplicationState: - description: > - Information and current values of the NFV-MANO functional - entity’s application state. - type: object - required: - - operationalState - - administrativeState - - usageState - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - nfvoSpecificInfo: - description: > - This type represents information attributes specific to an - NFVO entity, and that can be relevant to more than one - NFV-MANO service offered by an NFVO entity. - type: object - properties: - maxOnboardedNsdNum: - description: > - Maximum number of NSDs that can be on-boarded on the - NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - maxOnboardedVnfPkgNum: - description: > - Maximum number of VNF Packages that can be on-boarded on - the NFVO. - - NOTE: If this attribute is not present, the value of this - parameter is undefined. - type: integer - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - supportedNsdFormats: - description: | - Supported NSD data formats. - type: object - properties: - nsdFormat: - description: | - Name of the NSD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - nsdFormat - - standardVersion - required: - - supportedVnfdFormats - - supportedNsdFormats - vnfmSpecificInfo: - description: > - This type represents information attributes specific to a VNFM - entity, and that can be relevant to more than one NFV-MANO - service offered by a VNFM entity. - type: object - properties: - resoruceMgmtModeSupport: - description: | - The supported resource management modes of the VNFM. - Permitted values: - - DIRECT: The VNFM supports direct mode only. - - INDIRECT: The VNFM supports indirect mode only. - - BOTH: The VNFM supports both direct and indirect mode. - type: string - enum: - - DIRECT - - INDIRECT - - BOTH - managedVnfInstanceInfos: - description: > - The kinds of VNF instances that can be managed, e.g. to - determine the compatibility of a VNF with certain VNFM - according to the vnfmInfo attribute in the VNFD (see - table 7.1.2.2-1 in ETSI GS NFV-IFA 011). - type: array - items: - type: string - minItems: 1 - supportedVnfdFormats: - description: | - Supported VNFD data formats. - type: array - items: - type: object - properties: - vnfdFormat: - description: | - Name of the VNFD format. - Permitted values: - - TOSCA: The VNFD follows TOSCA definition, according to ETSI - GS NFV-SOL 001 standard. - - YANG: The VNFD follows YANG definition according to ETSI - GS NFV-SOL 006 standard. - type: string - enum: - - TOSCA - - YANG - standardVersion: - description: | - A version. - type: string - required: - - vnfdFormat - - standardVersion - minItems: 1 - required: - - resoruceMgmtModeSupport - - managedVnfInstanceInfos - - supportedVnfdFormats - vimSpecificInfo: - description: > - This type represents information attributes specific to a VIM - entity, and that can be relevant to more than one NFV-MANO - service offered by a VIM entity. - type: object - _links: - description: | - Links to resources related to this resource. - type: object - required: - - self - - manoServiceInterfaces - - peerEntities - - changeState - - changeStateOpOccs - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - manoServiceInterfaces: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - peerEntities: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeState: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - changeStateOpOccs: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - mano_entity.patch.200: - description: > - 200 OK - - Shall be returned when the modification of configuration on the - NFV-MANO functional entity has been accepted and completed. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on the "NFV-MANO entity" resource of the producer NFV-MANO - functional entity. The attributes that can be included consist of - those requested to be modified explicitly in the - "ManoConfigModificationRequest" data structure. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the - "name" attribute in "ManoEntity", as defined in clause - 5.6.2.3 - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "ManoEntity", as defined in clause - 5.6.2.3. - type: string - clockSyncs: - description: > - If present, this attribute signals modifications of the - "clockSyncs" attribute in "ManoEntityConfigurableParams", as - defined in clause 5.6.2.3. - type: array - items: - description: > - This type represents parameters for connecting to an NTP - server. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - type: - description: | - Type of clock synchronization. - Permitted values: - - NTP: For Network Time Protocol (NTP) based clock synchronization. - - OTHER: For other types of clock synchronization. - type: string - enum: - - NTP - - OTHER - ntpServerInfo: - description: > - Information for the NTP based clock synchronization. - Shall be present if type = "NTP". - type: object - properties: - ipAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of - an IPV4 address, string that consists of four - decimal integers separated by dots, each integer - ranging from 0 to 255. In case of an IPV6 address, - string that consists of groups of zero to four - hexadecimal digits, separated by colons. - type: string - format: IP - hostname: - description: "Indicates the hostname of the NTP server. \nNOTE:\tEither ipAddress or hostname shall be set, but not both at the same time.\n" - type: string - otherClockSyncParams: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - id - - type - clockSyncsDeleteIds: - description: > - If present, this attribute signals modifications of certain - entries in "clockSyncs" attribute in - "ManoEntityConfigurableParams", as defined in clause 5.6.2.3. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - defaultLogCompileBySizeValue: - description: | - Unsigned integer - type: number - defaultLogCompileByTimerValue: - description: | - Unsigned integer - type: number - manoServiceModifications: - description: > - If present, this attribute signals modifications of the - "manoServices" attribute array in the "ManoEntity", as - defined in clause 5.6.2.3. - type: array - items: - type: object - properties: - id: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - name: - description: > - If present, this attribute signals modification of the - "name" attribute in the "ManoService". - type: string - description: - description: > - If present, this attribute signals modification of the - "description" attribute in the "ManoService". - type: string - required: - - id - mano_entity.patch.409: - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "NFV-MANO - entity" resource. - - Typically, this is due to the fact that another configuration and - information modification is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-change_state.post.202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a "Location" HTTP header that contains - the URI of the newly-created "Individual change state operation - occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - mano_entity-change_state.post.409: - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interfaces.get.200: - description: > - 200 OK - - Shall be returned when information about zero or more NFV-MANO service - interfaces has been queried successfully. - - The response body shall contain in an array the representations of zero - or more NFV-MANO service interfaces, as defined in clause 5.6.2.11. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant to - (see also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. - The major version is defined in the standard the - interface is compliant to (see also clause 4.1 of ETSI - GS NFV-SOL 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO - functional entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API - producer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the authorization - server. Valid values of cipher suites are defined - in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the - SSL or TLS negotiation with the API client. Valid - values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - mano_entity-mano_interfaces.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface.get.200: - description: > - 200 OK - - Shall be returned when information about an individual NFV-MANO service - interface has been read successfully. - - The response body shall contain a representation of the NFV-MANO - service interface, as defined in clause 5.6.2.11. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents an individual NFV-MANO service interface - produced by an NFV-MANO functional entity. - type: object - properties: - id: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - name: - description: > - Human-readable name of the NFV-MANO functional entity - interface. - - This attribute can be modified with the PATCH method. - type: string - type: - description: > - Type of the NFV-MANO service interface produced by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - providerSpecificApiVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: | - Exposed API endpoint of the interface. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. Shall - be present for ETSI NFV specified RESTful NFV-MANO APIs. - The {apiName} of each interface is defined in the - standard the interface is compliant to (see also clause - 4.1 of ETSI GS NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. Shall be - present for ETSI NFV specified RESTful NFV-MANO APIs. The - major version is defined in the standard the interface is - compliant to (see also clause 4.1 of ETSI GS NFV-SOL - 013). May be present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - maxConcurrentIntOpNumber: - description: "Maximum number of concurrent operation requests supported on this interface. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - supportedOperations: - description: | - Information about supported operations of this interface. - type: array - items: - type: object - properties: - operationName: - description: | - Name of the operation supported on the interface. - type: string - maxConcurrentOpNumber: - description: "Maximum number of concurrent requests supported by the interface operation. \nNOTE:\tIf this attribute is not present, the value of this parameter is undefined. Overload is handled by the error handling schemes defined by the applicable API specification.\n" - type: integer - required: - - operationName - minItems: 1 - interfaceState: - description: | - State of the NFV-MANO service interface. - properties: - operationalState: - description: "The enumeration InterfaceOperationalStateEnumType defines values representing the operational state of an NFV-MANO service interface type of managed entity. The InterfaceOperationalStateEnumType shall comply with the provisions :\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - usageState: - description: "The enumeration UsageStateEnumType defines values representing the usage state of a managed entity. The UsageStateEnumType shall comply with the provisions:\n - IN_USE\tThe managed entity is currently being used.\n - NOT_IN_USE\tThe managed entity is currently not being used.\n" - type: string - enum: - - IN_USE - - NOT_IN_USE - required: - - operationalState - - administrativeState - - usageState - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - required: - - id - - name - - type - - standardVersion - - providerSpecificApiVersion - - apiVersion - - apiEndpoint - - supportedOperations - - interfaceState - mano_entity-mano_interface.patch.200: - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual NFV-MANO service interface" resource, - as defined in clause 5.6.2.13. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on an Individual NFV-MANO service interface" resource. The - attributes that can be included consist of those requested to be - modified explicitly in the - "ManoServiceInterfaceModificationRequest" data structure. If - applicable, additional attributes of the "ManoServiceInterface" - data structure that were modified implicitly shall also be - provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "ManoServiceInterface", as defined in clause - 5.6.2.11. - type: string - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - securityInfo: - description: > - This type represents security related information of an - NFV-MANO service interface produced by an NFV-MANO functional - entity. - type: object - properties: - authType: - description: > - Type of API request authorization to be used by the API - producer. - - The support of authorization methods for the API producer - is specified in clause 8.3.6 of ETSI GS NFV-SOL 013. - - Permitted values: - - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - - OAUTH2: Using access token, as defined by the OAuth 2.0 specification - in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - webFingerHost: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - webFingerHost - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - properties: - authServerId: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - authServerId - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the authorization server. - Valid values of cipher suites are defined in IETF RFC - 8447. - type: array - items: - type: string - minItems: 1 - required: - - providedConfiguration - - tlsCipherSuites - tlsTunnelInfo: - description: > - Information and configuration related to the use of TLS - tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: >- - List of cipher suites that shall be declared as - supported by the API producer when performing the SSL - or TLS negotiation with the API client. Valid values - of cipher suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - tlsTunnelCipherSuites - required: - - authType - - oauthServerInfo - metadata: - 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 pairs is represented as an object. It shall comply - with the provisions defined in clause 4 of IETF RFC 8259. In - the following example, a list of key-value pairs with four - keys ("aString", "aNumber", "anArray" and "anObject") is - provided to illustrate that the values associated with - different keys can be of different type. - type: object - mano_entity-mano_interface.patch.409: - description: > - 409 CONFLICT - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - NFV-MANO service interface" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - mano_entity-mano_interface-change_state.post.202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - - The response body shall be empty. - - The HTTP response shall include a “Location” HTTP header that contains - the URI of the newly-created "Individual change state operation - occurrence" resource corresponding to the operation. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - mano_entity-mano_interface-change_state.post.409: - description: > - 409 CONFLICT - - Shall be returned upon the following 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 resource is in an - incompatible state, or that another change state operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute shall convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - subscriptions.post.201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - - The response body shall contain a representation of the created - "Individual subscription" resource. - - The HTTP response shall include a "Location" HTTP header that points to - the created "Individual subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual subscription" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscriptions.post.303: - description: > - 303 SEE OTHER - - SShall be returned when a subscription with the same callbackURI and - the same filter already exists and the policy of NFV-MANO functional - entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the existing "Individual subscription" resource. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual subscription" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - subscriptions.get.200: - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations of all - active subscriptions of the functional block that invokes the method, - i.e., zero or more representations of NFV-MANO configuration and - information management subscriptions as defined in clause 5.6.2.6. - - If the "filter" URI parameter was supplied in the request, the data in - the response body shall have been transformed according to the rules - specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their associated - managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference to - NFV-MANO services in a filter. They should not be - used together in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed in - this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed in - this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscriptions.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - subscription.get.200: - description: > - 200 OK - - Shall be returned when information about an individual subscription has - been read successfully. - - The response body shall contain a representation of the "Individual - subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents a subscription related to notifications - about NFV-MANO configuration and information management changes - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a subscription filter related to - notifications about NFV-MANO configuration and information - management. - type: object - properties: - manoEntitySubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: "Match particular notification types. \nPermitted values:\n - InformationChangedNotification\n - ChangeStateNotification\n\nNOTE:\tThe permitted values of the \"notificationTypes\" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems.\n" - type: array - items: - type: string - enum: - - InformationChangedNotification - - ChangeStateNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - _links: - description: | - Links to resources related to this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - callbackUri - - _links - subscription.delete.204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has been - deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - change_state_ops.get.200: - description: > - 200 OK - - Shall be returned when status information for zero or more "change - state operation occurrences" has been queried successfully. - - The response body shall contain in an array the status information - about zero or more "Individual change state operation occurrences", as - defined in clause 5.6.2.9. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according - to IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according - to IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This - attribute shall be formatted according to the request data - type of the related change state operation. - - The following mapping between operationType and the data - type of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is - returned in a response to reading an individual resource, - and may be present according to the chosen attribute - selector parameter if this data type is returned in a - response to a query of a container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - change_state_ops.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: > - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - change_state_op.get.200: - description: > - 200 OK - - Shall be returned when information about an "Individual change state - operation occurrence" resource has been read successfully. - - The response body shall contain status information about a change state - operation occurrence, as defined in clause 5.6.2.9. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a Change state operation occurrence. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - operationState: - description: "The enumeration ChangeStateOpOccStateEnumType defines permitted values for the change state operation. It shall comply with the provisions :\n - PROCESSING\tThe change state operation is currently in execution.\n - COMPLETED\tThe change state operation has been completed successfully.\n - FAILED\tThe change state operation has failed.\n" - type: string - enum: - - PROCESSING - - COMPLETED - - FAILED - stateEnteredTime: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - startTime: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - managedObjectRef: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: | - An identifier with the intention of being globally unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - changeOperationalStateRequest: - description: "The enumeration ChangeOperationalStateEnumType defines permitted values for the change state operation. The ChangeOperationalStateEnumType shall comply with the provisions:\n - START\tTo start the managed entity.\n - STOP\tTo stop the managed entity.\n - RESTART\tTo stop and start again the managed entity.\n" - type: string - enum: - - START - - STOP - - RESTART - changeAdministrativeStateRequest: - description: "The enumeration ChangeAdministrativeStateEnumType defines permitted values for the change of administrative state operation. The ChangeAdministrativeStateEnumType shall comply with the provisions:\n - LOCK\tTo lock the managed entity.\n - UNLOCK\tTo unlock the managed entity.\n" - type: string - enum: - - LOCK - - UNLOCK - operationParams: - description: > - Input parameters of the change state operation. This attribute - shall be formatted according to the request data type of the - related change state operation. - - The following mapping between operationType and the data type - of this attribute shall apply: - - CHANGE_STATE: ChangeStateRequest - - This attribute shall be present if this data type is returned - in a response to reading an individual resource, and may be - present according to the chosen attribute selector parameter - if this data type is returned in a response to a query of a - container resource. - required: - - id - - operationState - - stateEnteredTime - - startTime - - managedObjectRef - peer_entities.post.201: - description: > - 201 CREATED - - Shall be returned when a new "Individual peer entity" resource has been - created successfully. - - The response body shall contain a representation of the created - resource with regards to a peer entity, as defined in clause 5.6.2.15. - - The HTTP response shall include a “Location” HTTP header that points to - the created "Individual peer entity" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: | - The resource URI of the created "Individual peer entity" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it with - the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entities.get.200: - description: > - 200 OK - - Shall be returned when information about zero or more peer entities has - been queried successfully. - - The response body shall contain in an array the resource - representations of zero or more peer entities, as defined in clause - 5.6.2.15. - - If the “filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative N°2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined - in clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be - accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated - form. Shall be present for ETSI NFV specified - RESTful NFV-MANO APIs. The {apiName} of each - interface is defined in the standard the interface - is compliant to (see also clause 4.1 of ETSI GS - NFV-SOL 013). May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in - the standard the interface is compliant to (see - also clause 4.1 of ETSI GS NFV-SOL 013). May be - present otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by - an NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by - the API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, - as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: - Using access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use - of TLS tunnel. Shall be present if authType - contains "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared - as supported by the API consumer when - performing the SSL or TLS negotiation with the - API producer. Valid values of cipher suites - are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it - with the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entities.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.get.200: - description: > - 200 OK - - Shall be returned when information about an individual peer functional - entity has been read successfully. - - The response body shall contain a resource representation of the peer - functional entity, as defined in clause 5.6.2.15. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents an individual peer entity. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - peerEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - name: - description: | - Human-readable name of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - type: - description: "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n" - type: string - enum: - - NFVO - - VNFM - - VIM - - WIM - - EM - - OSS - description: - description: | - Human-readable description of the peer functional entity. - This attribute can be modified with the PATCH method. - type: string - consumedManoInterfaces: - description: > - Information of the interface consumed by the NFV-MANO - functional entity from the peer functional entity. - - This attribute can be modified with the PATCH method. - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - peerEntityState: - description: > - State of the peer functional entity as provided by the API - consumer when creating the resource or when updating it with - the PATCH method. - type: object - properties: - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - required: - - operationalState - - administrativeState - required: - - id - - peerEntityId - - name - - type - - peerEntityState - peer_entitie.patch.200: - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - - The response body shall contain a representation of the attribute - modifications for the "Individual peer entity" resource, as defined in - clause 5.6.2.17. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type represents attribute modifications that were performed - on an "Individual peer entity" resource. The attributes that can - be included consist of those requested to be modified explicitly - in the "PeerEntityConfigModificationRequest" data structure. If - applicable, additional attributes of the "PeerEntity" data - structure that were modified implicitly shall also be provided. - type: object - properties: - name: - description: > - If present, this attribute signals modifications of the "name" - attribute in "PeerEntity", as defined in clause 5.6.2.15. - type: string - description: - description: > - If present, this attribute signals modifications of the - "description" attribute in "PeerEntity", as defined in clause - 5.6.2.15. - type: string - consumedManoInterfaces: - description: "If present, this attribute signals modifications of certain entries in \"consumedManoInterfaces\" attribute in \"PeerEntity\", as defined in clause 5.6.2.15. \nNOTE:\tDue to the security sensitive information contained within the attribute (refer to \"securityInfo\" within the \"ConsumedManoInterfaceInfo\"), based on access control policies, the API consumer might have read only, write only, read/write, or no access at all to the attribute’s value. In case the API consumer is not allowed to read the value of the security sensitive attribute, the attribute shall be omitted when the information is to be provided in a response message.\n" - type: array - items: - description: > - This type represents an interface consumed by the producer - NFV MANO functional entity from another peer functional - entity. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - name: - description: | - Human-readable name of the NFV-MANO interface. - type: string - type: - description: > - Type of the NFV-MANO service interface consumed by the - NFV-MANO functional entity. Valid values are defined in - clause 5.6.4.3. - type: string - standardVersion: - description: | - A version. - type: string - apiVersion: - description: | - A version. - type: string - apiEndpoint: - description: > - Consumable API endpoint of the interface. It provides - the information relevant about the protocol, host and - port, and path where the interface API can be accessed. - type: object - properties: - apiRoot: - description: | - String formatted according to IETF RFC 3986. - type: string - apiName: - description: > - Indicates the interface name in an abbreviated form. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The {apiName} of each interface is - defined in the standard the interface is compliant - to (see also clause 4.1 of ETSI GS NFV-SOL 013). - May be present otherwise. - type: string - apiMajorVersion: - description: > - Indicates the current major version of the API. - Shall be present for ETSI NFV specified RESTful - NFV-MANO APIs. The major version is defined in the - standard the interface is compliant to (see also - clause 4.1 of ETSI GS NFV-SOL 013). May be present - otherwise. - type: string - apiUri: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - apiUri - securityInfo: - description: > - This type represents security related information for - accessing an NFV-MANO service interface produced by an - NFV-MANO functional entity. - type: object - required: - - authType - - oauthServerInfo - properties: - authType: - description: > - Type of API request authorization to be used by the - API consumer accessing the API. - - The support of authorization methods for the API - consumer is specified in clause 8.3.6 of ETSI GS - NFV-SOL 013. - - Permitted values: - TLS_TUNNEL: Using TLS tunnel, as - defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using - access token, as defined by the OAuth 2.0 - specification in IETF RFC 6749. - type: array - items: - type: string - enum: - - TLS_TUNNEL - - OAUTH2 - minItems: 1 - oauthServerInfo: - description: > - OAuth 2.0 authorization server information and - configuration. - type: object - properties: - dynamicDiscovery: - description: "Configuration data used when performing dynamic discovery of the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - webFingerHost - properties: - webFingerHost: - description: > - Server where the WebFinger service is - hosted. When used, the request to the - WebFinger resource shall conform as - specified in clause 5.1.3 of ETSI GS - NFV-SEC 022. - type: string - format: uri - providedConfiguration: - description: "Configuration data used to setup the authorization server identifier. \nNOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration shall be supported, and dynamic configuration may be supported.\n" - type: object - required: - - authServerId - properties: - authServerId: - description: > - Authorization server identifier as defined - in ETSI GS NFV-SEC 022. - type: string - format: uri - tlsCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the - authorization server. Valid values of cipher - suites are defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - tlsTunnelInfo: - description: > - Information and configuration related to the use of - TLS tunnel. Shall be present if authType contains - "TLS_TUNNEL". - type: object - properties: - tlsTunnelCipherSuites: - description: > - List of cipher suites that shall be declared as - supported by the API consumer when performing - the SSL or TLS negotiation with the API - producer. Valid values of cipher suites are - defined in IETF RFC 8447. - type: array - items: - type: string - minItems: 1 - required: - - id - - name - - type - - standardVersion - - apiVersion - - apiEndpoint - consumedManoInterfaceDeleteIds: - description: > - If present, this attribute signals the deletions of certain - entries in the "consumedManoInterfaces" attribute in - "PeerEntity", as defined in clause 5.6.2.15. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - operationalState: - description: "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n" - type: string - enum: - - STARTED - - STOPPED - - STOPPING - - STARTING - - RESTARTING - administrativeState: - description: "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n" - type: string - enum: - - LOCKED - - UNLOCKED - - LOCKING - peer_entitie.patch.409: - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - peer entity" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.patch.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.delete.204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual peer entity" resource has been - deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - peer_entitie.delete.409: - description: > - 409 CONFLICT. - - Shall be returned upon the following error: The operation cannot be - executed currently, due to a conflict with the state of the "Individual - peer entity" resource. - - Typically, this is due to the fact that another operation is ongoing. - - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - peer_entitie.delete.412: - description: > - 412 PRECONDITION FAILED - - Shall be returned upon the following error: A precondition given in an - HTTP request header is not fulfilled. - - Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. - - The response body should contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot index 3680ae513..2fe757dd3 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/Subscriptions.robot @@ -176,11 +176,11 @@ DELETE Subscriptions - Method not implemented POST Create a new subscription - Unprocessable Entity [Documentation] Test ID: 8.3.1.10.13 ... Test title: POST Create a new Subscription - Unprocessable Entity - ... Test objective: The objective is to test that for a POST request for a new subscription, if the test by NFV-MANO for notification endpoint fails, then error 422 will be returned. + ... Test objective: The objective is to test that a new subscription is not created if the notification endpoint is unreachable by the NFV-MANO. ... Pre-conditions: none ... Reference: clause 5.5.4.3.1 - ETSI GS NFV-SOL 009 [7] v3.5.1 ... Config ID: Config_prod_NFV-MANO - ... Applicability: Notification endpoint test by NFV-MANO fails. + ... Applicability: Notification endpoint is unreachable by the NFV-MANO ... Post-Conditions: none Send Post Request for Subscription with Unreachable callbackUri Check HTTP Response Status Code Is 422 -- GitLab From a9091851991cba9d8ffac157cd1130b42890b5c8 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Tue, 19 Oct 2021 11:10:40 +0500 Subject: [PATCH 20/22] comment out unused variabes from CIM API variables.txt file --- .../NFVMANOCimKeywords.robot | 164 +++++++++--------- .../environment/variables.txt | 16 +- 2 files changed, 90 insertions(+), 90 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot index a88658791..c77617894 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/NFVMANOCimKeywords.robot @@ -33,7 +33,7 @@ Check HTTP Response Body Json Schema Is Send Post request for NFV-MANO Entity Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity ${output}= Output response Set Suite Variable ${response} ${output} @@ -41,7 +41,7 @@ Send Post request for NFV-MANO Entity GET NFV-MANO entity resource Log Trying to get a NFV-MANO entity resource Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity ${output}= Output response Set Suite Variable ${response} ${output} @@ -49,7 +49,7 @@ GET NFV-MANO entity resource Send Put request for NFV-MANO Entity Log Trying to perform a PUT (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/log_jobs/mano_entity ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -61,7 +61,7 @@ Send Patch request for NFV-MANO Entity log Trying to modify an NFV-MANO Entity Set Headers {"Accept":"${ACCEPT_JSON}"} Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${body}= Get File jsons/ManoConfigModificationRequest.json Patch ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity ${body} ${outputResponse}= Output response @@ -70,7 +70,7 @@ Send Patch request for NFV-MANO Entity Send Delete request for NFV-MANO Entity Log Trying to perform a DELETE (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity ${output}= Output response Set Suite Variable ${response} ${output} @@ -78,7 +78,7 @@ Send Delete request for NFV-MANO Entity Send Post request for NFV-MANO functional entity application state change Log Trying to perform a POST for NFV-MANO functional entity application state change Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${template}= Get File jsons/ChangeStateRequest.json ${body}= Format String ${template} state=${state} stateAction=${stateAction} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/change_state @@ -90,7 +90,7 @@ Wait for entity state change success notification and validate status Check entity state Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Get ${response['headers']['Location']} Log Validate Status code Integer response status 200 @@ -101,7 +101,7 @@ Check entity state Send Get request for NFV-MANO functional entity application state change Log Trying to perform a GET (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -109,7 +109,7 @@ Send Get request for NFV-MANO functional entity application state change Send Put request for NFV-MANO functional entity application state change Log Trying to perform a PUT (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/log_jobs/mano_entity/change_state ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -120,7 +120,7 @@ Send Put request for NFV-MANO functional entity application state change Send Patch request for NFV-MANO functional entity application state change Log Trying to perform a PATCH (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -128,7 +128,7 @@ Send Patch request for NFV-MANO functional entity application state change Send Delete request for NFV-MANO functional entity application state change Log Trying to perform a DELETE (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -136,7 +136,7 @@ Send Delete request for NFV-MANO functional entity application state change Send Post request for Change State Operation Occurrences Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${output}= Output response Set Suite Variable ${response} ${output} @@ -144,7 +144,7 @@ Send Post request for Change State Operation Occurrences Get Change State Operation Occurrences Log Query to GET information about multiple change state operation occurrences. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${outputResponse}= Output response @@ -152,7 +152,7 @@ Get Change State Operation Occurrences Get Change State Operation Occurrences with invalid filter Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?attribute_not_exist=some_value ${outputResponse}= Output response @@ -160,7 +160,7 @@ Get Change State Operation Occurrences with invalid filter Get Change State Operation Occurrences with invalid selector Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?fields=wrong_field ${outputResponse}= Output response @@ -169,7 +169,7 @@ Get Change State Operation Occurrences with invalid selector Get Change State Operation Occurrences with filter Log Query information about multiple change state operation occurrences with attribute filters. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?${filter}=${filter_value} ${outputResponse}= Output response @@ -178,7 +178,7 @@ Get Change State Operation Occurrences with filter Get Change State Operation Occurrences with all_fields attribute selector Log Queries information about multiple change state operation occurrences, using all_fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?exclude_default ${output}= Output response Set Suite Variable ${response} ${output} @@ -186,7 +186,7 @@ Get Change State Operation Occurrences with all_fields attribute selector Get Change State Operation Occurrences with fields attribute selector Log Queries information about multiple change state operation occurrences, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -194,7 +194,7 @@ Get Change State Operation Occurrences with fields attribute selector Get Change State Operation Occurrences with exclude_default attribute selector Log Queries information about multiple change state operation occurrences, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?exclude_default ${output}= Output response Set Suite Variable ${response} ${output} @@ -202,7 +202,7 @@ Get Change State Operation Occurrences with exclude_default attribute selector Get Change State Operation Occurrences with exclude_fields attribute selector Log Queries information about multiple change state operation occurrences, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?exclude_fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -210,7 +210,7 @@ Get Change State Operation Occurrences with exclude_fields attribute selector Get Change State Operation Occurrences with fields and exclude_default attribute selector Log Queries information about multiple change state operation occurrences, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops?exclude_default&fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -222,7 +222,7 @@ Check HTTP Response Header Contains Link Send PUT request for Change State Operation Occurrences log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -230,7 +230,7 @@ Send PUT request for Change State Operation Occurrences Send PATCH request for Change State Operation Occurrences log Trying to perform a PATCH. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Patch ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -238,7 +238,7 @@ Send PATCH request for Change State Operation Occurrences Send DELETE request for Change State Operation Occurrences log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -246,7 +246,7 @@ Send DELETE request for Change State Operation Occurrences Send Post request for Individual Change State Operation Occurrence Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${output}= Output response Set Suite Variable ${response} ${output} @@ -254,7 +254,7 @@ Send Post request for Individual Change State Operation Occurrence Get Individual Change State Operation Occurrence Log Query to GET information about individual change state operation occurrences. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${outputResponse}= Output response @@ -263,7 +263,7 @@ Get Individual Change State Operation Occurrence Send Put request for Individual Change State Operation Occurrence log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -271,7 +271,7 @@ Send Put request for Individual Change State Operation Occurrence Send Patch request for Individual Change State Operation Occurrence log Trying to perform a PATCH. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Patch ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -279,7 +279,7 @@ Send Patch request for Individual Change State Operation Occurrence Send Delete request for Individual Change State Operation Occurrence log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/change_state_ops/${changeStateOpOccId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -287,7 +287,7 @@ Send Delete request for Individual Change State Operation Occurrence Send Post request for NFV-MANO Service Interfaces Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${output}= Output response Set Suite Variable ${response} ${output} @@ -295,7 +295,7 @@ Send Post request for NFV-MANO Service Interfaces Get NFV-MANO Service Interfaces Log Query to GET information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${outputResponse}= Output response @@ -303,7 +303,7 @@ Get NFV-MANO Service Interfaces Get NFV-MANO Service Interfaces with invalid filter Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?attribute_not_exist=some_value ${outputResponse}= Output response @@ -311,7 +311,7 @@ Get NFV-MANO Service Interfaces with invalid filter Get NFV-MANO Service Interfaces with invalid selector Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?fields=wrong_field ${outputResponse}= Output response @@ -320,7 +320,7 @@ Get NFV-MANO Service Interfaces with invalid selector Get NFV-MANO Service Interfaces with filter Log Query information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity with attribute filters. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?${filter}=${filter_value} ${outputResponse}= Output response @@ -329,7 +329,7 @@ Get NFV-MANO Service Interfaces with filter Get NFV-MANO Service Interfaces with all_fields attribute selector Log Queries information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, using all_fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?exclude_default ${output}= Output response Set Suite Variable ${response} ${output} @@ -337,7 +337,7 @@ Get NFV-MANO Service Interfaces with all_fields attribute selector Get NFV-MANO Service Interfaces with exclude_default and fields attribute selector Log Queries information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, using all_fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?exclude_default&fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -345,7 +345,7 @@ Get NFV-MANO Service Interfaces with exclude_default and fields attribute select Get NFV-MANO Service Interfaces with fields attribute selector Log Queries information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -353,7 +353,7 @@ Get NFV-MANO Service Interfaces with fields attribute selector Get NFV-MANO Service Interfaces with exclude_fields attribute selector Log Queries information about multiple NFV-MANO service interfaces of the NFV-MANO functional entity, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces?exclude_fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -361,7 +361,7 @@ Get NFV-MANO Service Interfaces with exclude_fields attribute selector Send PUT request for NFV-MANO Service Interfaces log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -369,7 +369,7 @@ Send PUT request for NFV-MANO Service Interfaces Send PATCH request for NFV-MANO Service Interfaces log Trying to perform a PATCH. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Patch ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -377,7 +377,7 @@ Send PATCH request for NFV-MANO Service Interfaces Send DELETE request for NFV-MANO Service Interfaces log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -385,14 +385,14 @@ Send DELETE request for NFV-MANO Service Interfaces Send Post request for Individual NFV-MANO Service Interface Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${output}= Output response Set Suite Variable ${response} ${output} Get Individual NFV-MANO Service Interface Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${outputResponse}= Output response @@ -401,7 +401,7 @@ Get Individual NFV-MANO Service Interface Send Put request for Individual NFV-MANO Service Interface log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -410,7 +410,7 @@ Send Patch request for Individual NFV-MANO Service Interface log Trying to modify an NFV-MANO Entity Set Headers {"Accept":"${ACCEPT_JSON}"} Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${body}= Get File jsons/ManoServiceInterfaceModificationRequest.json Patch ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${body} ${outputResponse}= Output response @@ -419,7 +419,7 @@ Send Patch request for Individual NFV-MANO Service Interface Send Delete request for Individual NFV-MANO Service Interface log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -427,7 +427,7 @@ Send Delete request for Individual NFV-MANO Service Interface Send Post request for Change interface state task Log Trying to perform a POST for Change interface state task Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${template}= Get File jsons/ChangeStateRequest.json ${body}= Format String ${template} state=${state} stateAction=${stateAction} POST ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${body} @@ -439,7 +439,7 @@ Check PostCondition NFV-MANO service interface state matches the requested state Check interface state Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Get ${response['headers']['Location']} Log Validate Status code Integer response status 200 @@ -450,7 +450,7 @@ Check interface state Send Get request for Change interface state task Log Trying to perform a GET (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -458,7 +458,7 @@ Send Get request for Change interface state task Send Put request for Change interface state task Log Trying to perform a PUT (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -469,7 +469,7 @@ Send Put request for Change interface state task Send Patch request for Change interface state task Log Trying to perform a PATCH (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -477,7 +477,7 @@ Send Patch request for Change interface state task Send Delete request for Change interface state task Log Trying to perform a DELETE (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}//mano_entity/mano_interfaces/${manoServiceInterfaceId}/change_state ${output}= Output response Set Suite Variable ${response} ${output} @@ -485,7 +485,7 @@ Send Delete request for Change interface state task Send Post request for Peer Entity Log Trying to perform a POST for Peer Entity Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${template}= Get File jsons/CreatePeerEntityRequest.json ${body}= Format String ${template} peerEntityId=${peerEntityId} name=${name} type=${type} POST ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${body} @@ -495,7 +495,7 @@ Send Post request for Peer Entity Get Peer Entities Log Query to GET information about multiple peer entities. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${outputResponse}= Output response @@ -503,7 +503,7 @@ Get Peer Entities Get Peer Entities with invalid filter Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?attribute_not_exist=some_value ${outputResponse}= Output response @@ -511,7 +511,7 @@ Get Peer Entities with invalid filter Get Peer Entities with invalid selector Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?fields=wrong_field ${outputResponse}= Output response @@ -520,7 +520,7 @@ Get Peer Entities with invalid selector Get Peer Entities with filter Log Query information about multiple peer entities with attribute filters. Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?${filter}=${filter_value} ${outputResponse}= Output response @@ -529,7 +529,7 @@ Get Peer Entities with filter Get Peer Entities with all_fields attribute selector Log Queries information about multiple peer entities, using all_fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?exclude_default ${output}= Output response Set Suite Variable ${response} ${output} @@ -537,7 +537,7 @@ Get Peer Entities with all_fields attribute selector Get Peer Entities with fields attribute selector Log Queries information about multiple peer entities, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -545,7 +545,7 @@ Get Peer Entities with fields attribute selector Get Peer Entity with exclude_default and fields attribute selector Log Queries information about multiple peer entities, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?exclude_default&fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -553,7 +553,7 @@ Get Peer Entity with exclude_default and fields attribute selector Get Peer Entities with exclude_fields attribute selector Log Queries information about multiple peer entities, using fields Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities?exclude_fields=${fields} ${output}= Output response Set Suite Variable ${response} ${output} @@ -561,7 +561,7 @@ Get Peer Entities with exclude_fields attribute selector Send PUT request for Peer Entities log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -569,7 +569,7 @@ Send PUT request for Peer Entities Send PATCH request for Peer Entities log Trying to perform a PATCH. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Patch ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -577,7 +577,7 @@ Send PATCH request for Peer Entities Send DELETE request for Peer Entities log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -585,14 +585,14 @@ Send DELETE request for Peer Entities Send Post request for Individual Peer Entity Log Trying to perform a POST (method should not be implemented) Set Headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${output}= Output response Set Suite Variable ${response} ${output} Get Individual Peer Entity Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${outputResponse}= Output response @@ -601,7 +601,7 @@ Get Individual Peer Entity Send Put request for Individual Peer Entity log Trying to perform a PUT. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Put ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -610,7 +610,7 @@ Send Patch request for Individual Peer Entity log Trying to modify an NFV-MANO Entity Set Headers {"Accept":"${ACCEPT_JSON}"} Set Headers {"Content-Type": "${CONTENT_TYPE_PATCH}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${body}= Get File jsons/PeerEntityConfigModificationRequest.json Patch ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${body} ${outputResponse}= Output response @@ -619,7 +619,7 @@ Send Patch request for Individual Peer Entity Send Delete request for Individual Peer Entity log Trying to perform a DELETE. This method should not be implemented Set Headers {"Accept":"${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization":"${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} Delete ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities/${peerEntityId} ${outputResponse}= Output response Set Global Variable @{response} ${outputResponse} @@ -706,7 +706,7 @@ Check Postcondition Subscription Is Set Send Post Request for Duplicated Subscription Set headers {"Content-Type": "${CONTENT_TYPE_JSON}"} Set headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} ${template}= Get File jsons/CimSubscriptionRequest.json ${body_request}= Format String ${template} callback_uri=${callback_uri} callback_endpoint=${callback_endpoint} POST ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${body_request} allow_redirects=false @@ -735,7 +735,7 @@ Check Postcondition Subscription Resource Returned in Location Header Is Availab Send Put Request for Subscriptions [Documentation] This method is not supported. When this method is requested on this resource, the NFV-MANO shall return a "405 Method ... Not Allowed" response as defined in clause 4.3.5.4. - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} PUT ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${output}= Output response Set Suite Variable ${response} ${output} @@ -743,7 +743,7 @@ Send Put Request for Subscriptions Send Patch Request for Subscriptions [Documentation] This method is not supported. When this method is requested on this resource, the NFV-MANO shall return a "405 Method ... Not Allowed" response as defined in clause 4.3.5.4. - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} PATCH ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${output}= Output response Set Suite Variable ${response} ${output} @@ -751,14 +751,14 @@ Send Patch Request for Subscriptions Send Delete Request for Subscriptions [Documentation] This method is not supported. When this method is requested on this resource, the NFV-MANO shall return a "405 Method ... Not Allowed" response as defined in clause 4.3.5.4. - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions ${output}= Output response Set Suite Variable ${response} ${output} Get Individual Subscription Set headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${subscriptionId} ${output}= Output response Set Suite Variable ${response} ${output} @@ -770,14 +770,14 @@ Check HTTP Response Body Subscription Identifier matches the requested Subscript GET individual Subscription with invalid resource identifier Set headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${erroneousSubscriptionId} ${output}= Output response Set Suite Variable ${response} ${output} Send Delete request for individual Subscription Set headers {"Accept": "${ACCEPT_JSON}"} - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${subscriptionId} ${output}= Output response Set Suite Variable ${response} ${output} @@ -789,19 +789,19 @@ Check Postcondition Subscription is Deleted Send Delete request for individual Subscription with invalid resource identifier Log Trying to delete a subscription in the VNFM with invalid id - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} DELETE ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${erroneousSubscriptionId} ${output}= Output response Set Suite Variable @{response} ${output} Send Post request for individual Subscription - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} POST ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${newSubscriptionId} ${output}= Output response Set Suite Variable @{response} ${output} Send Put request for individual Subscription - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${subscriptionId} ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -810,7 +810,7 @@ Send Put request for individual Subscription Set Suite Variable @{response} ${output} Send Patch request for individual Subscription - Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"Authorization": "${AUTHORIZATION}"} + Run Keyword If ${AUTH_USAGE} == 1 Set Headers {"${AUTHORIZATION_HEADER}":"${AUTHORIZATION_TOKEN}"} GET ${apiRoot}/${apiName}/${apiMajorVersion}/subscriptions/${subscriptionId} ${origOutput}= Output response Set Suite Variable ${origResponse} ${origOutput} @@ -834,7 +834,7 @@ GET Peer Entities with malformed authorization token Pass Execution If ${AUTH_USAGE} == 0 Skipping test as NFVO is not supporting authentication Log The GET method queries using invalid token Set Headers {"Accept": "${ACCEPT_JSON}"} - Set Headers {"Authorization": "${BAD_AUTHORIZATION}"} + Set Headers {"${AUTHORIZATION_HEADER}": "${BAD_AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${output}= Output response @@ -853,7 +853,7 @@ GET Peer Entities with expired or revoked authorization token Pass Execution If ${AUTH_USAGE} == 0 Skipping test as it is not supporting authentication Log The GET method queries using invalid token Set Headers {"Accept": "${ACCEPT_JSON}"} - Set Headers {"Authorization": "${NEG_AUTHORIZATION}"} + Set Headers {"${AUTHORIZATION_HEADER}": "${NEG_AUTHORIZATION_TOKEN}"} Log Execute Query and validate response Get ${apiRoot}/${apiName}/${apiMajorVersion}/peer_entities ${output}= Output response diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt index b86b897ab..887bff0d9 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt @@ -3,19 +3,19 @@ ${NFVMANOHOST} localhost ${NFVMANO_PORT} 8080 ${NFVMANO_SCHEMA} https -${AUTHORIZATION} Bearer 0b79bab50daca910b000d4f1a2b675d604257e42 -${NEG_AUTHORIZATION} Bearer negativetoken -${WRONG_AUTHORIZATION} Bearer XXXXXWRONGXXXXX -${BAD_AUTHORIZATION} Bear sometoken +${AUTHORIZATION_TOKEN} Bearer 0b79bab50daca910b000d4f1a2b675d604257e42 +${NEG_AUTHORIZATION_TOKEN} Bearer negativetoken +#${WRONG_AUTHORIZATION_TOKEN} Bearer XXXXXWRONGXXXXX +${BAD_AUTHORIZATION_TOKEN} Bear sometoken ${CONTENT_TYPE_JSON} application/json ${ACCEPT_JSON} application/json ${CONTENT_TYPE_PATCH} application/merge-patch+json ${AUTH_USAGE} 1 -${FIELD_USAGE} 1 +#${FIELD_USAGE} 1 ${NFVMANO_CHECKS_NOTIF_ENDPOINT} 1 ## If true, during subscription, the FUT performs a get to the notification endpoint -${NFVMANO_ALLOWS_DUPLICATE_SUBS} 1 +#${NFVMANO_ALLOWS_DUPLICATE_SUBS} 1 ${apiRoot} / ${apiMajorVersion} v2 @@ -41,8 +41,8 @@ ${callback_endpoint} /subscriptions ${filter_ok} callbackUri=${callbackUri} ${filter_ko} erroneousFilter=erroneous ${callback_endpoint_fwd} /endpoint/check -${callback_endpoint_error} /subs_404 -${sleep_interval} 20s +#${callback_endpoint_error} /subs_404 +#${sleep_interval} 20s ${total_polling_time} 2 min ${polling_interval} 10 sec -- GitLab From 8ccbf20ab777e6fbc3408c3ffcd9817546811e1a Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Tue, 19 Oct 2021 11:15:21 +0500 Subject: [PATCH 21/22] removed unused OpenAPI yaml --- ...L009-NFVMANOPerformanceManagement-API.yaml | 20940 ---------------- 1 file changed, 20940 deletions(-) delete mode 100644 SOL009/NFVMANOPerformanceManagement-API/SOL009-NFVMANOPerformanceManagement-API.yaml diff --git a/SOL009/NFVMANOPerformanceManagement-API/SOL009-NFVMANOPerformanceManagement-API.yaml b/SOL009/NFVMANOPerformanceManagement-API/SOL009-NFVMANOPerformanceManagement-API.yaml deleted file mode 100644 index 38e44fa0c..000000000 --- a/SOL009/NFVMANOPerformanceManagement-API/SOL009-NFVMANOPerformanceManagement-API.yaml +++ /dev/null @@ -1,20940 +0,0 @@ -openapi: 3.0.2 -info: - version: '1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1' - title: SOL009 - NFV-MANO Performance Management Interface - description: > - SOL009 - NFV-MANO Performance 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' - contact: - name: NFV-SOL WG -externalDocs: - description: ETSI GS NFV-SOL 009 V3.3.1 - url: >- - https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf -servers: - - url: 'http://0.0.0.0/nfvmanopm/v1' - description: | - API HTTP Server - - url: 'https://0.0.0.0/nfvmanopm/v1' - description: | - API HTTPS Server -paths: - /api_versions: - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: false - schema: - type: string - - name: Authorization - description: 'The authorization token for the request. Reference: IETF RFC 7235' - in: header - required: false - schema: - type: string - get: - summary: Retrieve API version information - description: > - The GET method reads API version information. This method shall follow - the provisions specified in table 4.6.3.3.3.2-1 for request and response - data structures, and response codes. URI query parameters are not - supported. - responses: - '200': - description: > - 200 OK - - API version information was read successfully. The response body - shall contain 4.4 API version information, as defined in clause - 4.4.1.13. - content: - application/json: - schema: - description: | - This type represents API version information. - type: object - required: - - uriPrefix - - apiVersions - properties: - uriPrefix: - description: > - Specifies the URI prefix for the API, in the following - form {apiRoot}/{apiName}/{apiMajorVersion}/. - type: string - apiVersions: - description: > - Version(s) supported for the API signaled by the uriPrefix - attribute. - type: array - items: - type: object - required: - - version - properties: - version: - description: > - Identifies a supported version. The value of the - version attribute shall be a version identifier as - specified in clause 9.1 (SOL013). - type: string - isDeprecated: - description: > - If such information is available, this attribute - indicates whether use of the version signaled by the - version attribute is deprecated (true) or not - (false). - - A deprecated version is still supported by the API - producer but is recommended not to be used any - longer. When a version is no longer supported, it - does not appear in the response body. - type: boolean - retirementDate: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - schema: - type: string - maximum: 1 - minimum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '413': - description: > - 413 PAYLOAD TOO LARGE - - If the payload body of a request is larger than the amount of data - the API producer is willing or able to process, it shall respond - with this response code, following the provisions in IETF RFC 7231 - for the use of the "Retry-After" HTTP header and for closing the - connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '414': - description: > - 414 URI TOO LONG - - If the request URI of a request is longer than the API producer is - willing or able to process, it shall respond with this response - code. This condition can e.g. be caused by passing long queries in - the request URI of a GET request. The "ProblemDetails" structure may - be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '416': - description: | - 416 Range Not Satisfiable - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '429': - description: > - 429 TOO MANY REQUESTS - - If the API consumer has sent too many requests in a defined period - of time and the API producer is able to detect that condition ("rate - limiting"), the API producer shall respond with this response code, - following the provisions in IETF RFC 6585 [17] for the use of the - "Retry-After" HTTP header. The "ProblemDetails" structure shall be - provided and shall include in the "detail" attribute more - information about the source of the problem. - - The period of time and allowed number of requests are configured - within the API producer by means outside the scope of the present - document. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /pm_jobs: - post: - description: > - Creates a PM job. - - This method shall follow the provisions specified in the tables - 6.5.3.3.1-1 and 6.5.3.3.1-2 for URI query parameters, request and - response data structures, and response codes. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: | - PM job creation request. - content: - application/json: - schema: - description: | - This type represents a request to create a PM job. - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS - NFV-IFA 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which - performance information is requested to be collected. This - attribute shall contain the identifier of the instance of - the measure object according to their type. See also - definitions in clause 8.2 of ETSI GS NFV-IFA 031. If more - than one identifier is provided, values shall all refer to - measured object instances of the same type, for which the - same criteria is then applicable. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance for which performance information is - requested to be collected. May be present if a sub-object - is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type. If this attribute is present, - the cardinality of the "objectInstanceIds" attribute shall - be 1. If this attribute is absent and a sub-object is - defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type, measurements will be taken - for all sub-object instances of the measured object - instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the - specified measured object(s). This attribute’s value - shall contain the related "Measurement Name" values as - defined in clause 8.4 of ETSI GS NFV-IFA 031. At least - one of the two attributes (performance metric or group) - shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a - pre-defined list of metrics, known to the producer that - it can decompose to individual metrics. This - attribute’s value shall contain the related - "Measurement Group" values as defined in clause 8.4 of - ETSI GS NFV-IFA 031. At least one of the two attributes - (performance metric or group) shall be present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will - collect performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of the - collectionPeriod. In the latter case, the performance - data for the collection periods within one reporting - period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can be - supported depends on the capability of the producing - entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will - report to the API consumer about performance - information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of the - collectionPeriod. In the latter case, the performance - data for the collection periods within one reporting - period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can be - supported depends on the capability of the producing - entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - required: - - objectType - - objectInstanceIds - - criteria - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when the PM job has been created successfully. - - The response body shall contain a representation of the created - "Individual PM job" resource, as defined in clause 6.6.2.7. - - The HTTP response shall include a "Location" HTTP header that - points to the created "Individual PM job" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a PM job. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: > - Type of measured object. The applicable measured object - type for a measurement is defined in clause 8.2 of ETSI - GS NFV-IFA 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which - performance information is collected. This attribute - shall contain the identifier of the instance of the - measure object according to their type. See also - definitions in clause 8.2 of ETSI GS NFV-IFA 031. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance for which performance information is - requested to be collected. May be present if a sub-object - is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type. If this attribute is - present, the cardinality of the "objectInstanceIds" - attribute shall be 1. If this attribute is absent and a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA - 031 for the related measured object type, measurements - will be taken for all sub-object instances of the - measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the - specified measured object(s). This attribute’s value - shall contain the related "Measurement Name" values - as defined in clause 8.4 of ETSI GS NFV-IFA 031. At - least one of the two attributes (performance metric or - group) shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a - pre-defined list of metrics, known to the producer - that it can decompose to individual metrics. This - attribute’s value shall contain the related - "Measurement Group" values as defined in clause 8.4 of - ETSI GS NFV-IFA 031. At least one of the two - attributes (performance metric or group) shall be - present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will - collect performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of - the collectionPeriod. In the latter case, the - performance data for the collection periods within one - reporting period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can be - supported depends on the capability of the producing - entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will - report to the API consumer about performance - information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of - the collectionPeriod. In the latter case, the - performance data for the collection periods within one - reporting period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can be - supported depends on the capability of the producing - entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - reports: - description: > - Information about available reports collected by this PM - job. - type: array - items: - type: object - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - readyTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - expiryTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - fileSize: - description: | - Unsigned integer - type: number - required: - - href - - readyTime - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - objects: - description: > - Links to resources representing the measured object - instances for which performance information is - collected. Shall be present if the measured object - instance information is accessible as a resource. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceIds - - criteria - - _links - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: | - The client can use this method to retrieve information about PM jobs. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the PmJob and in data types - referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of - ETSI GS NFV-SOL 013. The NFV-MANO functional entity shall support - this parameter. - in: query - required: false - schema: - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. See clause 5.3 - of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional entity - should support this parameter. - in: query - required: false - schema: - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the PmJob structure - in the response body if this parameter is provided, or none of the - parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - none - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about zero or more PM jobs has - been queried successfully. - - The response body shall contain in an array the representations of - zero or more PM jobs, as defined in clause 6.6.2.7. - - If the "filter" URI parameter or one of the "all_fields", "fields" - (if supported), "exclude_fields" (if supported) or - "exclude_default" URI parameters was supplied in the request, the - data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL - 013, respectively. - - If the NFV-MANO functional entity supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013 . - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents a PM job. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - objectType: - description: > - Type of measured object. The applicable measured object - type for a measurement is defined in clause 8.2 of ETSI - GS NFV-IFA 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which - performance information is collected. This attribute - shall contain the identifier of the instance of the - measure object according to their type. See also - definitions in clause 8.2 of ETSI GS NFV-IFA 031. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance for which performance information is - requested to be collected. May be present if a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA - 031 for the related measured object type. If this - attribute is present, the cardinality of the - "objectInstanceIds" attribute shall be 1. If this - attribute is absent and a sub-object is defined in - clause 8.2 of ETSI GS NFV-IFA 031 for the related - measured object type, measurements will be taken for - all sub-object instances of the measured object - instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for - the specified measured object(s). This attribute’s - value shall contain the related "Measurement Name" - values as defined in clause 8.4 of ETSI GS NFV-IFA - 031. At least one of the two attributes - (performance metric or group) shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a - pre-defined list of metrics, known to the producer - that it can decompose to individual metrics. This - attribute’s value shall contain the related - "Measurement Group" values as defined in clause 8.4 - of ETSI GS NFV-IFA 031. At least one of the two - attributes (performance metric or group) shall be - present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will - collect performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer - will inform the API consumer about availability of - the performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of - the collectionPeriod. In the latter case, the - performance data for the collection periods within - one reporting period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can - be supported depends on the capability of the - producing entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will - report to the API consumer about performance - information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer - will inform the API consumer about availability of - the performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of - the collectionPeriod. In the latter case, the - performance data for the collection periods within - one reporting period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can - be supported depends on the capability of the - producing entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - reports: - description: > - Information about available reports collected by this PM - job. - type: array - items: - type: object - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - readyTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - expiryTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - fileSize: - description: | - Unsigned integer - type: number - required: - - href - - readyTime - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - objects: - description: > - Links to resources representing the measured object - instances for which performance information is - collected. Shall be present if the measured object - instance information is accessible as a resource. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceIds - - criteria - - _links - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/pm_jobs/{pmJobId}': - parameters: - - name: pmJobId - in: path - description: Identifier of the PM Job - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: | - The client can use this method for reading an individual PM job. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual PM job has - been read successfully. - - The response body shall contain a representation of the "Individual - PM job" resource, as defined in clause 6.6.2.7. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a PM job. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: > - Type of measured object. The applicable measured object - type for a measurement is defined in clause 8.2 of ETSI - GS NFV-IFA 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which - performance information is collected. This attribute - shall contain the identifier of the instance of the - measure object according to their type. See also - definitions in clause 8.2 of ETSI GS NFV-IFA 031. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance for which performance information is - requested to be collected. May be present if a sub-object - is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type. If this attribute is - present, the cardinality of the "objectInstanceIds" - attribute shall be 1. If this attribute is absent and a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA - 031 for the related measured object type, measurements - will be taken for all sub-object instances of the - measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the - specified measured object(s). This attribute’s value - shall contain the related "Measurement Name" values - as defined in clause 8.4 of ETSI GS NFV-IFA 031. At - least one of the two attributes (performance metric or - group) shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a - pre-defined list of metrics, known to the producer - that it can decompose to individual metrics. This - attribute’s value shall contain the related - "Measurement Group" values as defined in clause 8.4 of - ETSI GS NFV-IFA 031. At least one of the two - attributes (performance metric or group) shall be - present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will - collect performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of - the collectionPeriod. In the latter case, the - performance data for the collection periods within one - reporting period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can be - supported depends on the capability of the producing - entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will - report to the API consumer about performance - information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of - the collectionPeriod. In the latter case, the - performance data for the collection periods within one - reporting period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can be - supported depends on the capability of the producing - entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - reports: - description: > - Information about available reports collected by this PM - job. - type: array - items: - type: object - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - readyTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - expiryTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - fileSize: - description: | - Unsigned integer - type: number - required: - - href - - readyTime - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - objects: - description: > - Links to resources representing the measured object - instances for which performance information is - collected. Shall be present if the measured object - instance information is accessible as a resource. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceIds - - criteria - - _links - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: | - This method terminates an individual PM job. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: | - 204 NO CONTENT - Shall be returned when the PM job has been deleted successfully. - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/pm_jobs/{pmJobId}/reports/{reportId}': - parameters: - - name: pmJobId - in: path - description: Identifier of the PM Job - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - - name: reportId - in: path - description: Identifier of the PM report - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - The client can use this method for reading an individual performance - report. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information of an individual performance - report has been read successfully. - - The response body shall contain a representation of the "Individual - performance report" resource, as defined in clause 6.6.2.10. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type defines the format of a performance report provided - by the NFV-MANO functional entity to the API consumer as a - result of collecting performance information as part of a PM - job. - type: object - properties: - entries: - description: > - List of performance information entries. Each performance - report entry is for a given metric of a given object - (i.e. measured object instance) corresponding to the - related measured object types, but can include multiple - collected values. - type: array - items: - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured - object type for a measurement is defined in clause - 8.2 of ETSI GS NFV-IFA 031. - type: string - objectInstanceId: - description: > - This type represents the identifier to reference a - managed object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted - values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable - if attribute "manoEntityComponents" in - "ManoEntity" is supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being - globally unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - required: - - type - - objectId - subObjectInstanceId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - performanceMetric: - description: > - Name of the metric collected. This attribute shall - contain the related "Measurement Name" value as - defined in clause 8.4 of ETSI GS NFV-IFA 031. - type: string - performanceValues: - description: > - List of performance values with associated - timestamp. - type: array - items: - type: object - properties: - timeStamp: - description: > - Date-time stamp. Representation: String - formatted according to IETF RFC 3339. - type: string - format: date-time - value: - description: > - Value of the metric collected. The type of - this attribute shall correspond to the - related "Measurement Unit" as defined in - clause 8.4 of ETSI GS NFV-IFA 031. - context: - 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 - pairs is represented as an object. It shall - comply with the provisions defined in clause 4 - of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys - ("aString", "aNumber", "anArray" and - "anObject") is provided to illustrate that the - values associated with different keys can be - of different type. - type: object - required: - - timeStamp - - value - minItems: 1 - required: - - objectType - - objectInstanceId - - performanceMetric - - performanceValues - minItems: 1 - required: - - entries - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /thresholds: - post: - description: | - The POST method can be used by the client to create a threshold. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: | - Request parameters to create a threshold. - content: - application/json: - schema: - description: | - This type represents a request to create a threshold. - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS - NFV-IFA 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance associated with this threshold. May be - present if a sub-object is defined in clause 8.2 of ETSI GS - NFV-IFA 031 for the related measured object type. If this - attribute is absent and a sub-object is defined in clause - 8.2 of ETSI GS NFV-IFA 031 for the related measured object - type, thresholds will be set for all sub-object instances - of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the - threshold. This attribute’s value shall contain the - related "Measurement Name" values as defined in clause - 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which other - attributes are present in the data structure. Permitted - values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are defined. - The definition of additional threshold types is left - for future specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - required: - - objectType - - objectInstanceId - - criteria - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when a threshold has been created successfully. - - The response body shall contain a representation of the created - "Individual threshold" resource, as defined in clause 6.6.2.9. - - The HTTP response shall include a "Location" HTTP header that - contains the resource URI of the created "Individual threshold" - resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: '' - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: >- - Type of measured object. The applicable measured object - type for a measurement is defined in clause 8.2 of ETSI GS - NFV-IFA 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance associated with this threshold. May be - present if a sub-object is defined in clause 8.2 of ETSI - GS NFV-IFA 031 for the related measured object type. If - this attribute is absent and a sub-object is defined in - clause 8.2 of ETSI GS NFV-IFA 031 for the related - measured object type, thresholds are set for all - sub-object instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the - threshold. This attribute’s value shall contain the - related "Measurement Name" values as defined in - clause 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which - other attributes are present in the data structure. - Permitted values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are - defined. The definition of additional threshold types - is left for future specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - object: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceId - - subjObjectInstanceIds - - criteria - - _links - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: | - The client can use this method to query information about thresholds. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the Threshold and in data types - referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about zero or more thresholds - has been queried successfully. - - The response body shall contain in an array the representations of - zero or more thresholds, as defined in clause 6.6.2.9. - - If the "filter" URI parameter was supplied in the request, the data - in the response body shall have been transformed according to the - rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - type: array - items: - description: '' - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - objectType: - description: >- - Type of measured object. The applicable measured object - type for a measurement is defined in clause 8.2 of ETSI - GS NFV-IFA 031. - type: string - objectInstanceId: - description: > - An identifier with the intention of being globally - unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance associated with this threshold. May be - present if a sub-object is defined in clause 8.2 of ETSI - GS NFV-IFA 031 for the related measured object type. If - this attribute is absent and a sub-object is defined in - clause 8.2 of ETSI GS NFV-IFA 031 for the related - measured object type, thresholds are set for all - sub-object instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the - threshold. This attribute’s value shall contain the - related "Measurement Name" values as defined in - clause 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which - other attributes are present in the data structure. - Permitted values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are - defined. The definition of additional threshold - types is left for future specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - object: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceId - - subjObjectInstanceIds - - criteria - - _links - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/thresholds/{thresholdId}': - parameters: - - name: thresholdId - in: path - description: Identifier of the PM threshold - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: | - The client can use this method for reading an individual threshold - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when information about an individual threshold - has been read successfully. - - The response body shall contain a representation of the threshold, - as defined in clause 6.6.2.9. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: '' - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: >- - Type of measured object. The applicable measured object - type for a measurement is defined in clause 8.2 of ETSI GS - NFV-IFA 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance associated with this threshold. May be - present if a sub-object is defined in clause 8.2 of ETSI - GS NFV-IFA 031 for the related measured object type. If - this attribute is absent and a sub-object is defined in - clause 8.2 of ETSI GS NFV-IFA 031 for the related - measured object type, thresholds are set for all - sub-object instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the - threshold. This attribute’s value shall contain the - related "Measurement Name" values as defined in - clause 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which - other attributes are present in the data structure. - Permitted values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are - defined. The definition of additional threshold types - is left for future specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - object: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceId - - subjObjectInstanceIds - - criteria - - _links - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: | - This method allows to delete a threshold. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: | - 204 NO CONTENT - Shall be returned when the threshold has been deleted successfully. - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - /subscriptions: - post: - description: | - The POST method creates a new subscription. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - requestBody: - description: | - Details of the subscription to be created. - content: - application/json: - schema: - description: | - This type represents a subscription request. - type: object - properties: - filter: - description: > - This type represents a filter that can be used to subscribe - for notifications related to performance management - events. At a particular nesting level in the filter - structure, the following applies: All attributes shall - match in order for the filter to match (logical "and" - between different filter attributes). If an attribute is an - array, the attribute shall match if at least one of the - values in the array matches (logical "or" between the - values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their associated - managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference to - NFV-MANO services in a filter. They should not be - used together in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed in - this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed in - this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" - attribute are spelled exactly as the names of the - notification types to facilitate automated code - generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization - which 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The clientId and - clientPassword passed in a subscription shall not be - the same as the clientId and clientPassword that are - used to obtain authorization for API requests. - Client credentials may differ between subscriptions. - The value of clientPassword should be generated by a - random process. - 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. The clientId and - clientPassword passed in a subscription shall not be - the same as the clientId and clientPassword that are - used to obtain authorization for API requests. - Client credentials may differ between subscriptions. - The value of clientPassword should be generated by a - random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - required: true - responses: - '201': - description: > - 201 CREATED - - Shall be returned when the subscription has been created - successfully. - - A representation of the created subscription resource shall be - returned in the response body, as defined in clause 6.6.2.3. - - The HTTP response shall include a "Location" HTTP header that - contains the resource URI of the created "Individual subscription" - resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: | - This type represents a subscription. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a filter that can be used to - subscribe for notifications related to performance - management events. At a particular nesting level in the - filter structure, the following applies: All attributes - shall match in order for the filter to match (logical - "and" between different filter attributes). If an - attribute is an array, the attribute shall match if at - least one of the values in the array matches (logical "or" - between the values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference - to NFV-MANO services in a filter. They should not - be used together in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed - in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed - in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted - values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" - attribute are spelled exactly as the names of the - notification types to facilitate automated code - generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - The URI of the endpoint to send the notification to. - type: object - properties: - links: - description: | - String formatted according to IETF RFC 3986. - type: string - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - links - - self - required: - - id - - callbackUri - '303': - description: > - 303 SEE OTHER - - Shall be returned when a subscription with the same callbackURI and - the same filter already exists and the policy of the NFV-MANO - functional entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that - contains the resource URI of the existing "Individual subscription" - resource. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state - operation occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - get: - description: > - The client can use this method to query the list of active - subscriptions to performance management notifications subscribed by the - client. - parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of - ETSI GS NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this - parameter as part of the URI query string. The API consumer may - supply this parameter. - - All attribute names that appear in the PmSubscription and in data - types referenced from it shall be supported by the NFV-MANO - functional entity in the expression. - in: query - required: false - schema: - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the NFV-MANO functional entity if the entity supports - alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS - NFV-SOL 013 for this resource. - in: query - required: false - schema: - type: string - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations of - all active subscriptions of the functional block that invokes the - method, i.e. zero or more representations of PM subscriptions as - defined in clause 6.6.2.3. - - If the "filter" URI parameter was supplied in the request, the data - in the response body shall have been transformed according to the - rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this - resource, inclusion of the Link HTTP header in this response shall - follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - type: array - items: - description: | - This type represents a subscription. - type: object - properties: - id: - description: > - An identifier with the intention of being globally - unique. - type: string - filter: - description: > - This type represents a filter that can be used to - subscribe for notifications related to performance - management events. At a particular nesting level in the - filter structure, the following applies: All attributes - shall match in order for the filter to match (logical - "and" between different filter attributes). If an - attribute is an array, the attribute shall match if at - least one of the values in the array matches (logical - "or" between the values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being - globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the - respective type within a NFV-MANO functional - entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to - reference to NFV-MANO services in a filter. They - should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity - produced interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the - respective type within a NFV-MANO functional - entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity - produced interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives - to reference to NFV-MANO functional entity - consumed interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives - to reference to NFV-MANO functional entity - consumed interfaces in a filter. They should - not be used both in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted - values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" - attribute are spelled exactly as the names of the - notification types to facilitate automated code - generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - The URI of the endpoint to send the notification to. - type: object - properties: - links: - description: | - String formatted according to IETF RFC 3986. - type: string - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - links - - self - required: - - id - - callbackUri - '400': - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '/subscriptions/{subscriptionId}': - parameters: - - name: subscriptionId - in: path - description: Identifier of the subscription - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - get: - description: > - The client can use this method for reading an individual subscription - about performance management notifications subscribed by the client. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '200': - description: > - 200 OK - - Shall be returned when the subscription has been read successfully. - - The response body shall contain a representation of the "Individual - subscription" resource, as defined in clause 6.6.2.3. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a subscription. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a filter that can be used to - subscribe for notifications related to performance - management events. At a particular nesting level in the - filter structure, the following applies: All attributes - shall match in order for the filter to match (logical - "and" between different filter attributes). If an - attribute is an array, the attribute shall match if at - least one of the values in the array matches (logical "or" - between the values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their - associated managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an - NFV-MANO service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference - to NFV-MANO services in a filter. They should not - be used together in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but - that need not be globally unique. - Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed - in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - description: > - An identifier with the intention of being - globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed - in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used - both in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted - values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" - attribute are spelled exactly as the names of the - notification types to facilitate automated code - generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - The URI of the endpoint to send the notification to. - type: object - properties: - links: - description: | - String formatted according to IETF RFC 3986. - type: string - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - links - - self - required: - - id - - callbackUri - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - delete: - description: | - This method terminates an individual subscription. - parameters: - - name: Version - description: | - Version of the API requested to use when responding to this request. - in: header - required: true - schema: - type: string - - name: Accept - description: > - Content-Types that are acceptable for the response. Reference: IETF - RFC 7231. - in: header - required: true - schema: - type: string - - name: Authorization - description: | - The authorization token for the request. Reference: IETF RFC 7235. - in: header - required: false - schema: - type: string - responses: - '204': - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has - been deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - '400': - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the - specific cause has to be proper specified in the "ProblemDetails" - structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the - request URI contains incorrect query parameters or the payload body - contains a syntactically incorrect data structure), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource - would be so big that the performance of the API producer is - adversely affected, and the API producer does not support paging for - the affected resource, it shall respond with this response code. The - "ProblemDetails" structure shall be provided, and should include in - the "detail" attribute more information about the source of the - problem. - - If there is an application error related to the client's input that - cannot be easily mapped to any other HTTP response code ("catch all - error"), the API producer shall respond with this response code. The - "ProblemDetails" structure shall be provided, and shall include in - the "detail" attribute more information about the source of the - problem. - - If the request contains a malformed access token, the API producer - should respond with this response. The details of the error shall be - returned in the WWW Authenticate HTTP header, as defined in IETF RFC - 6750 and IETF RFC 7235. The ProblemDetails structure may be - provided. - - The use of this HTTP error response code described above is - applicable to the use of the OAuth 2.0 for the authorization of API - requests and notifications, as defined in clauses 4.5.3.3 and - 4.5.3.4. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '401': - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, - or if the request contains an authorization token that is invalid - (e.g. expired or revoked), the API producer should respond with this - response. The details of the error shall be returned in the - WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF - RFC 7235. The ProblemDetails structure may be provided. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '403': - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request - to a particular resource, the API producer shall respond with this - response code. The "ProblemDetails" structure shall be provided. It - should include in the "detail" attribute information about the - source of the problem, and may indicate how to solve it. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '404': - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the - resource addressed by the URI passed in the request or is not - willing to disclose that one exists, it shall respond with this - response code. The "ProblemDetails" structure may be provided, - including in the "detail" attribute information about the source of - the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed - by the URI is a container resource which is designed to contain - child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty - container resource, a typical response contains a 200 OK response - code and a payload body with an empty array. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '405': - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular - resource, the API producer shall respond with this response code. - The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '406': - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a - content type that is acceptable to the API producer, the API - producer shall respond with this response code. The "ProblemDetails" - structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '422': - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data - (e.g. well-formed JSON) but the data cannot be processed (e.g. - because it fails validation against a schema), the API producer - shall respond with this response code. The "ProblemDetails" - structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a - request body. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '500': - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input - that cannot be easily mapped to any other HTTP response code ("catch - all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include - in the "detail" attribute more information about the source of the - problem. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '503': - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of - itself or of a system it relies on, it should respond with this - response code, following the provisions in IETF RFC 7231 for the use - of the "Retry-After" HTTP header and for the alternative to refuse - the connection. The "ProblemDetails" structure may be omitted. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - '504': - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a - response from an upstream server (i.e. a server that the API - producer communicates with when fulfilling a request), it should - respond with this response code. - headers: - Content-Type: - description: The MIME type of the body of the response. - schema: - 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. - schema: - type: string - maximum: 1 - minimum: 0 - Version: - description: | - Version of the API used in the response. - schema: - type: string - maximum: 1 - minimum: 1 - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure - from IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 -components: - schemas: - PmSubscriptionRequest: - description: | - This type represents a subscription request. - type: object - properties: - filter: - description: > - This type represents a filter that can be used to subscribe for - notifications related to performance management events. At a - particular nesting level in the filter structure, the following - applies: All attributes shall match in order for the filter to - match (logical "and" between different filter attributes). If an - attribute is an array, the attribute shall match if at least one of - the values in the array matches (logical "or" between the values of - one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" attribute are - spelled exactly as the names of the notification types to - facilitate automated code generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The - clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are - used to obtain authorization for API requests. Client - credentials may differ between subscriptions. The value of - clientPassword should be generated by a random process. - 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. The - clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are - used to obtain authorization for API requests. Client - credentials may differ between subscriptions. The value of - clientPassword should be generated by a random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - PmSubscription: - description: | - This type represents a subscription. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a filter that can be used to subscribe for - notifications related to performance management events. At a - particular nesting level in the filter structure, the following - applies: All attributes shall match in order for the filter to - match (logical "and" between different filter attributes). If an - attribute is an array, the attribute shall match if at least one of - the values in the array matches (logical "or" between the values of - one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference - to NFV-MANO functional entity produced interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference - to NFV-MANO functional entity consumed interfaces in a - filter. They should not be used both in the same filter - instance, but one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" attribute are - spelled exactly as the names of the notification types to - facilitate automated code generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - The URI of the endpoint to send the notification to. - type: object - properties: - links: - description: | - String formatted according to IETF RFC 3986. - type: string - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - links - - self - required: - - id - - callbackUri - CreatePmJobRequest: - description: | - This type represents a request to create a PM job. - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured object type for a - measurement is defined in clause 8.2 of ETSI GS NFV-IFA 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which performance - information is requested to be collected. This attribute shall - contain the identifier of the instance of the measure object - according to their type. See also definitions in clause 8.2 of ETSI - GS NFV-IFA 031. If more than one identifier is provided, values - shall all refer to measured object instances of the same type, for - which the same criteria is then applicable. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance for which performance information is requested to be - collected. May be present if a sub-object is defined in clause 8.2 - of ETSI GS NFV-IFA 031 for the related measured object type. If this - attribute is present, the cardinality of the "objectInstanceIds" - attribute shall be 1. If this attribute is absent and a sub-object - is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the related - measured object type, measurements will be taken for all sub-object - instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the specified - measured object(s). This attribute’s value shall contain the - related "Measurement Name" values as defined in clause 8.4 of - ETSI GS NFV-IFA 031. At least one of the two attributes - (performance metric or group) shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a pre-defined - list of metrics, known to the producer that it can decompose to - individual metrics. This attribute’s value shall contain the - related "Measurement Group" values as defined in clause 8.4 of - ETSI GS NFV-IFA 031. At least one of the two attributes - (performance metric or group) shall be present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will collect - performance information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will inform the - API consumer about availability of the performance data - collected for each completed collection period during this - reportingPeriod. The reportingPeriod should be equal to or a - multiple of the collectionPeriod. In the latter case, the - performance data for the collection periods within one reporting - period are reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported depends on - the capability of the producing entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will report to - the API consumer about performance information. The unit shall - be seconds. - - At the end of each reportingPeriod, the producer will inform the - API consumer about availability of the performance data - collected for each completed collection period during this - reportingPeriod. The reportingPeriod should be equal to or a - multiple of the collectionPeriod. In the latter case, the - performance data for the collection periods within one reporting - period are reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported depends on - the capability of the producing entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - required: - - objectType - - objectInstanceIds - - criteria - PmJob: - description: | - This type represents a PM job. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: > - Type of measured object. The applicable measured object type for a - measurement is defined in clause 8.2 of ETSI GS NFV-IFA 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which performance - information is collected. This attribute shall contain the - identifier of the instance of the measure object according to their - type. See also definitions in clause 8.2 of ETSI GS NFV-IFA 031. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance for which performance information is requested to be - collected. May be present if a sub-object is defined in clause 8.2 - of ETSI GS NFV-IFA 031 for the related measured object type. If this - attribute is present, the cardinality of the "objectInstanceIds" - attribute shall be 1. If this attribute is absent and a sub-object - is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the related - measured object type, measurements will be taken for all sub-object - instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the specified - measured object(s). This attribute’s value shall contain the - related "Measurement Name" values as defined in clause 8.4 of - ETSI GS NFV-IFA 031. At least one of the two attributes - (performance metric or group) shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a pre-defined - list of metrics, known to the producer that it can decompose to - individual metrics. This attribute’s value shall contain the - related "Measurement Group" values as defined in clause 8.4 of - ETSI GS NFV-IFA 031. At least one of the two attributes - (performance metric or group) shall be present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will collect - performance information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will inform the - API consumer about availability of the performance data - collected for each completed collection period during this - reportingPeriod. The reportingPeriod should be equal to or a - multiple of the collectionPeriod. In the latter case, the - performance data for the collection periods within one reporting - period are reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported depends on - the capability of the producing entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will report to - the API consumer about performance information. The unit shall - be seconds. - - At the end of each reportingPeriod, the producer will inform the - API consumer about availability of the performance data - collected for each completed collection period during this - reportingPeriod. The reportingPeriod should be equal to or a - multiple of the collectionPeriod. In the latter case, the - performance data for the collection periods within one reporting - period are reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported depends on - the capability of the producing entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - reports: - description: | - Information about available reports collected by this PM job. - type: array - items: - type: object - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - readyTime: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - expiryTime: - description: > - Date-time stamp. Representation: String formatted according to - IETF RFC 3339. - type: string - format: date-time - fileSize: - description: | - Unsigned integer - type: number - required: - - href - - readyTime - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - objects: - description: > - Links to resources representing the measured object instances - for which performance information is collected. Shall be - present if the measured object instance information is - accessible as a resource. - type: array - items: - description: > - This type represents a link to a resource using an absolute - URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceIds - - criteria - - _links - CreateThresholdRequest: - description: | - This type represents a request to create a threshold. - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured object type for a - measurement is defined in clause 8.2 of ETSI GS NFV-IFA 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance associated with this threshold. May be present if a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type. If this attribute is absent and a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type, thresholds will be set for all - sub-object instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the threshold. - This attribute’s value shall contain the related "Measurement - Name" values as defined in clause 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which other - attributes are present in the data structure. Permitted values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are defined. The - definition of additional threshold types is left for future - specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - required: - - objectType - - objectInstanceId - - criteria - Threshold: - description: '' - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: >- - Type of measured object. The applicable measured object type for a - measurement is defined in clause 8.2 of ETSI GS NFV-IFA 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance associated with this threshold. May be present if a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type. If this attribute is absent and a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type, thresholds are set for all sub-object - instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally unique. - Representation: string of variable length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the threshold. - This attribute’s value shall contain the related "Measurement - Name" values as defined in clause 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which other - attributes are present in the data structure. Permitted values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are defined. The - definition of additional threshold types is left for future - specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - object: - description: | - This type represents a link to a resource using an absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceId - - subjObjectInstanceIds - - criteria - - _links - PerformanceReport: - description: > - This type defines the format of a performance report provided by the - NFV-MANO functional entity to the API consumer as a result of - collecting performance information as part of a PM job. - type: object - properties: - entries: - description: > - List of performance information entries. Each performance report - entry is for a given metric of a given object (i.e. measured object - instance) corresponding to the related measured object types, but - can include multiple collected values. - type: array - items: - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA - 031. - type: string - objectInstanceId: - description: > - This type represents the identifier to reference a managed - object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: | - An identifier with the intention of being globally unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - required: - - type - - objectId - subObjectInstanceId: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - performanceMetric: - description: > - Name of the metric collected. This attribute shall contain the - related "Measurement Name" value as defined in clause 8.4 of - ETSI GS NFV-IFA 031. - type: string - performanceValues: - description: | - List of performance values with associated timestamp. - type: array - items: - type: object - properties: - timeStamp: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - value: - description: > - Value of the metric collected. The type of this - attribute shall correspond to the related "Measurement - Unit" as defined in clause 8.4 of ETSI GS NFV-IFA 031. - context: - 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 pairs is represented as an - object. It shall comply with the provisions defined in - clause 4 of IETF RFC 8259. In the following example, a - list of key-value pairs with four keys ("aString", - "aNumber", "anArray" and "anObject") is provided to - illustrate that the values associated with different - keys can be of different type. - type: object - required: - - timeStamp - - value - minItems: 1 - required: - - objectType - - objectInstanceId - - performanceMetric - - performanceValues - minItems: 1 - required: - - entries - PmNotificationsFilter: - description: > - This type represents a filter that can be used to subscribe for - notifications related to performance management events. At a - particular nesting level in the filter structure, the following - applies: All attributes shall match in order for the filter to match - (logical "and" between different filter attributes). If an attribute is - an array, the attribute shall match if at least one of the values in - the array matches (logical "or" between the values of one filter - attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to match NFV-MANO - functional entities and their associated managed objects. - type: object - properties: - manoEntityId: - description: | - An identifier with the intention of being globally unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO service - name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" are - alternatives to reference to NFV-MANO services in a filter. - They should not be used together in the same filter instance, - but one alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced interfaces - with an instance identifier listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference to - NFV-MANO functional entity produced interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type within a - NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced interfaces - with an instance Name listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to reference to - NFV-MANO functional entity produced interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed interfaces - with an instance identifier listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference to - NFV-MANO functional entity consumed interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed interfaces - with an instance Name listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to reference to - NFV-MANO functional entity consumed interfaces in a filter. - They should not be used both in the same filter instance, but - one alternative should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" attribute are - spelled exactly as the names of the notification types to - facilitate automated code generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - PmJobCriteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the specified - measured object(s). This attribute’s value shall contain the - related "Measurement Name" values as defined in clause 8.4 of ETSI - GS NFV-IFA 031. At least one of the two attributes (performance - metric or group) shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a pre-defined list - of metrics, known to the producer that it can decompose to - individual metrics. This attribute’s value shall contain the - related "Measurement Group" values as defined in clause 8.4 of ETSI - GS NFV-IFA 031. At least one of the two attributes (performance - metric or group) shall be present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will collect - performance information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will inform the API - consumer about availability of the performance data collected for - each completed collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of the - collectionPeriod. In the latter case, the performance data for the - collection periods within one reporting period are reported - together. - - In particular when choosing short collection and reporting periods, - the number of PM jobs that can be supported depends on the - capability of the producing entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will report to the - API consumer about performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer will inform the API - consumer about availability of the performance data collected for - each completed collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of the - collectionPeriod. In the latter case, the performance data for the - collection periods within one reporting period are reported - together. - - In particular when choosing short collection and reporting periods, - the number of PM jobs that can be supported depends on the - capability of the producing entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted according to IETF - RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - ThresholdCriteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the threshold. This - attribute’s value shall contain the related "Measurement Name" - values as defined in clause 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which other attributes - are present in the data structure. Permitted values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are defined. The - definition of additional threshold types is left for future - specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - responses: - pm_jobs.post.201: - description: > - 201 CREATED - - Shall be returned when the PM job has been created successfully. - - The response body shall contain a representation of the created - "Individual PM job" resource, as defined in clause 6.6.2.7. - - The HTTP response shall include a "Location" HTTP header that points to - the created "Individual PM job" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a PM job. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: > - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA - 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which - performance information is collected. This attribute shall - contain the identifier of the instance of the measure object - according to their type. See also definitions in clause 8.2 of - ETSI GS NFV-IFA 031. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance for which performance information is requested to be - collected. May be present if a sub-object is defined in - clause 8.2 of ETSI GS NFV-IFA 031 for the related measured - object type. If this attribute is present, the cardinality of - the "objectInstanceIds" attribute shall be 1. If this - attribute is absent and a sub-object is defined in clause 8.2 - of ETSI GS NFV-IFA 031 for the related measured object type, - measurements will be taken for all sub-object instances of - the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the - specified measured object(s). This attribute’s value - shall contain the related "Measurement Name" values as - defined in clause 8.4 of ETSI GS NFV-IFA 031. At least - one of the two attributes (performance metric or group) - shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a - pre-defined list of metrics, known to the producer that - it can decompose to individual metrics. This attribute’s - value shall contain the related "Measurement Group" - values as defined in clause 8.4 of ETSI GS NFV-IFA 031. - At least one of the two attributes (performance metric or - group) shall be present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will - collect performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed collection - period during this reportingPeriod. The reportingPeriod - should be equal to or a multiple of the collectionPeriod. - In the latter case, the performance data for the - collection periods within one reporting period are - reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported - depends on the capability of the producing entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will - report to the API consumer about performance information. - The unit shall be seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed collection - period during this reportingPeriod. The reportingPeriod - should be equal to or a multiple of the collectionPeriod. - In the latter case, the performance data for the - collection periods within one reporting period are - reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported - depends on the capability of the producing entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - reports: - description: | - Information about available reports collected by this PM job. - type: array - items: - type: object - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - readyTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - expiryTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - fileSize: - description: | - Unsigned integer - type: number - required: - - href - - readyTime - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - objects: - description: > - Links to resources representing the measured object - instances for which performance information is collected. - Shall be present if the measured object instance - information is accessible as a resource. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceIds - - criteria - - _links - pm_jobs.get.200: - description: > - 200 OK - - Shall be returned when information about zero or more PM jobs has been - queried successfully. - - The response body shall contain in an array the representations of zero - or more PM jobs, as defined in clause 6.6.2.7. - - If the "filter" URI parameter or one of the "all_fields", "fields" (if - supported), "exclude_fields" (if supported) or "exclude_default" URI - parameters was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clauses - 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - - If the NFV-MANO functional entity supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013 . - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Link: - description: > - Reference to other resources. Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL - 013. - schema: - type: string - minimum: 0 - maximum: 1 - content: - application/json: - schema: - type: array - items: - description: | - This type represents a PM job. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: > - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS - NFV-IFA 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which - performance information is collected. This attribute shall - contain the identifier of the instance of the measure - object according to their type. See also definitions in - clause 8.2 of ETSI GS NFV-IFA 031. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance for which performance information is - requested to be collected. May be present if a sub-object - is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type. If this attribute is present, - the cardinality of the "objectInstanceIds" attribute shall - be 1. If this attribute is absent and a sub-object is - defined in clause 8.2 of ETSI GS NFV-IFA 031 for the - related measured object type, measurements will be taken - for all sub-object instances of the measured object - instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the - specified measured object(s). This attribute’s value - shall contain the related "Measurement Name" values as - defined in clause 8.4 of ETSI GS NFV-IFA 031. At least - one of the two attributes (performance metric or group) - shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a - pre-defined list of metrics, known to the producer that - it can decompose to individual metrics. This - attribute’s value shall contain the related - "Measurement Group" values as defined in clause 8.4 of - ETSI GS NFV-IFA 031. At least one of the two attributes - (performance metric or group) shall be present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will - collect performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of the - collectionPeriod. In the latter case, the performance - data for the collection periods within one reporting - period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can be - supported depends on the capability of the producing - entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will - report to the API consumer about performance - information. The unit shall be seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed - collection period during this reportingPeriod. The - reportingPeriod should be equal to or a multiple of the - collectionPeriod. In the latter case, the performance - data for the collection periods within one reporting - period are reported together. - - In particular when choosing short collection and - reporting periods, the number of PM jobs that can be - supported depends on the capability of the producing - entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - reports: - description: > - Information about available reports collected by this PM - job. - type: array - items: - type: object - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - readyTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - expiryTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - fileSize: - description: | - Unsigned integer - type: number - required: - - href - - readyTime - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - objects: - description: > - Links to resources representing the measured object - instances for which performance information is - collected. Shall be present if the measured object - instance information is accessible as a resource. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceIds - - criteria - - _links - pm_jobs.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Invalid attribute selector. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - pm_job.get.200: - description: > - 200 OK - - Shall be returned when information about an individual PM job has been - read successfully. - - The response body shall contain a representation of the "Individual PM - job" resource, as defined in clause 6.6.2.7. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a PM job. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: > - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA - 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which - performance information is collected. This attribute shall - contain the identifier of the instance of the measure object - according to their type. See also definitions in clause 8.2 of - ETSI GS NFV-IFA 031. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance for which performance information is requested to be - collected. May be present if a sub-object is defined in - clause 8.2 of ETSI GS NFV-IFA 031 for the related measured - object type. If this attribute is present, the cardinality of - the "objectInstanceIds" attribute shall be 1. If this - attribute is absent and a sub-object is defined in clause 8.2 - of ETSI GS NFV-IFA 031 for the related measured object type, - measurements will be taken for all sub-object instances of - the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the - specified measured object(s). This attribute’s value - shall contain the related "Measurement Name" values as - defined in clause 8.4 of ETSI GS NFV-IFA 031. At least - one of the two attributes (performance metric or group) - shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a - pre-defined list of metrics, known to the producer that - it can decompose to individual metrics. This attribute’s - value shall contain the related "Measurement Group" - values as defined in clause 8.4 of ETSI GS NFV-IFA 031. - At least one of the two attributes (performance metric or - group) shall be present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will - collect performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed collection - period during this reportingPeriod. The reportingPeriod - should be equal to or a multiple of the collectionPeriod. - In the latter case, the performance data for the - collection periods within one reporting period are - reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported - depends on the capability of the producing entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will - report to the API consumer about performance information. - The unit shall be seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed collection - period during this reportingPeriod. The reportingPeriod - should be equal to or a multiple of the collectionPeriod. - In the latter case, the performance data for the - collection periods within one reporting period are - reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported - depends on the capability of the producing entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - reports: - description: | - Information about available reports collected by this PM job. - type: array - items: - type: object - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - readyTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - expiryTime: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - fileSize: - description: | - Unsigned integer - type: number - required: - - href - - readyTime - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - objects: - description: > - Links to resources representing the measured object - instances for which performance information is collected. - Shall be present if the measured object instance - information is accessible as a resource. - type: array - items: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceIds - - criteria - - _links - pm_job.delete.204: - description: | - 204 NO CONTENT - Shall be returned when the PM job has been deleted successfully. - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - pm_job.report.get.200: - description: > - 200 OK - - Shall be returned when information of an individual performance report - has been read successfully. - - The response body shall contain a representation of the "Individual - performance report" resource, as defined in clause 6.6.2.10. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - This type defines the format of a performance report provided by - the NFV-MANO functional entity to the API consumer as a result of - collecting performance information as part of a PM job. - type: object - properties: - entries: - description: > - List of performance information entries. Each performance - report entry is for a given metric of a given object (i.e. - measured object instance) corresponding to the related - measured object types, but can include multiple collected - values. - type: array - items: - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured object - type for a measurement is defined in clause 8.2 of ETSI - GS NFV-IFA 031. - type: string - objectInstanceId: - description: > - This type represents the identifier to reference a - managed object of a particular type. - type: object - properties: - type: - description: > - Indicates the type of managed object. Permitted - values: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - - The "MANO_ENTITY COMPONENT" is only applicable if - attribute "manoEntityComponents" in "ManoEntity" is - supported by the API producer. - type: string - enum: - - MANO_ENTITY - - MANO_SERVICE - - MANO_SERVICE_IF - - CONSUMED_MANO_IF - - MANO_ENTITY_COMPONENT - objectId: - description: > - An identifier with the intention of being globally - unique. - type: string - subObjectId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - required: - - type - - objectId - subObjectInstanceId: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not - be globally unique. Representation: string of variable - length.. - type: string - performanceMetric: - description: > - Name of the metric collected. This attribute shall - contain the related "Measurement Name" value as defined - in clause 8.4 of ETSI GS NFV-IFA 031. - type: string - performanceValues: - description: | - List of performance values with associated timestamp. - type: array - items: - type: object - properties: - timeStamp: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - value: - description: > - Value of the metric collected. The type of this - attribute shall correspond to the related - "Measurement Unit" as defined in clause 8.4 of - ETSI GS NFV-IFA 031. - context: - 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 pairs is - represented as an object. It shall comply with the - provisions defined in clause 4 of IETF RFC 8259. - In the following example, a list of key-value - pairs with four keys ("aString", "aNumber", - "anArray" and "anObject") is provided to - illustrate that the values associated with - different keys can be of different type. - type: object - required: - - timeStamp - - value - minItems: 1 - required: - - objectType - - objectInstanceId - - performanceMetric - - performanceValues - minItems: 1 - required: - - entries - thresholds.post.201: - description: > - 201 CREATED - - Shall be returned when a threshold has been created successfully. - - The response body shall contain a representation of the created - "Individual threshold" resource, as defined in clause 6.6.2.9. - - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the created "Individual threshold" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: '' - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: >- - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA - 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance associated with this threshold. May be present if a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for - the related measured object type. If this attribute is absent - and a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA - 031 for the related measured object type, thresholds are set - for all sub-object instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the - threshold. This attribute’s value shall contain the - related "Measurement Name" values as defined in clause - 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which other - attributes are present in the data structure. Permitted - values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are defined. - The definition of additional threshold types is left for - future specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - object: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceId - - subjObjectInstanceIds - - criteria - - _links - thresholds.get.200: - description: > - 200 OK - - Shall be returned when information about zero or more thresholds has - been queried successfully. - - The response body shall contain in an array the representations of zero - or more thresholds, as defined in clause 6.6.2.9. - - If the "filter" URI parameter was supplied in the request, the data in - the response body shall have been transformed according to the rules - specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - type: array - items: - description: '' - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: >- - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS - NFV-IFA 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured - object instance associated with this threshold. May be - present if a sub-object is defined in clause 8.2 of ETSI GS - NFV-IFA 031 for the related measured object type. If this - attribute is absent and a sub-object is defined in clause - 8.2 of ETSI GS NFV-IFA 031 for the related measured object - type, thresholds are set for all sub-object instances of - the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need not be - globally unique. Representation: string of variable - length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the - threshold. This attribute’s value shall contain the - related "Measurement Name" values as defined in clause - 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which other - attributes are present in the data structure. Permitted - values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are defined. - The definition of additional threshold types is left - for future specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - object: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceId - - subjObjectInstanceIds - - criteria - - _links - thresholds.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - threshold.get.200: - description: > - 200 OK - - Shall be returned when information about an individual threshold has - been read successfully. - - The response body shall contain a representation of the threshold, as - defined in clause 6.6.2.9. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: '' - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - objectType: - description: >- - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA - 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance associated with this threshold. May be present if a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for - the related measured object type. If this attribute is absent - and a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA - 031 for the related measured object type, thresholds are set - for all sub-object instances of the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the - threshold. This attribute’s value shall contain the - related "Measurement Name" values as defined in clause - 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which other - attributes are present in the data structure. Permitted - values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are defined. - The definition of additional threshold types is left for - future specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - _links: - description: | - Links for this resource. - type: object - properties: - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - object: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - self - required: - - id - - objectType - - objectInstanceId - - subjObjectInstanceIds - - criteria - - _links - threshold.delete.204: - description: | - 204 NO CONTENT - Shall be returned when the threshold has been deleted successfully. - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - subscriptions.post.201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - - A representation of the created subscription resource shall be returned - in the response body, as defined in clause 6.6.2.3. - - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the created "Individual subscription" resource. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - content: - application/json: - schema: - description: | - This type represents a subscription. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a filter that can be used to subscribe - for notifications related to performance management events. - At a particular nesting level in the filter structure, the - following applies: All attributes shall match in order for - the filter to match (logical "and" between different filter - attributes). If an attribute is an array, the attribute shall - match if at least one of the values in the array matches - (logical "or" between the values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" attribute - are spelled exactly as the names of the notification - types to facilitate automated code generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - The URI of the endpoint to send the notification to. - type: object - properties: - links: - description: | - String formatted according to IETF RFC 3986. - type: string - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - links - - self - required: - - id - - callbackUri - subscriptions.post.303: - description: > - 303 SEE OTHER - - Shall be returned when a subscription with the same callbackURI and the - same filter already exists and the policy of the NFV-MANO functional - entity is to not create redundant subscriptions. - - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the existing "Individual subscription" resource. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - Location: - description: > - The resource URI of the created "Individual change state operation - occurence" resource. - schema: - type: string - format: url - minimum: 1 - maximum: 1 - subscriptions.get.200: - description: > - Shall be returned when the list of subscriptions has been queried - successfully. - - The response body shall contain in an array the representations of all - active subscriptions of the functional block that invokes the method, - i.e. zero or more representations of PM subscriptions as defined in - clause 6.6.2.3. - - If the "filter" URI parameter was supplied in the request, the data in - the response body shall have been transformed according to the rules - specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - - If the NFV-MANO functional entity supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - inclusion of the Link HTTP header in this response shall follow the - provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - type: array - items: - description: | - This type represents a subscription. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a filter that can be used to subscribe - for notifications related to performance management - events. At a particular nesting level in the filter - structure, the following applies: All attributes shall - match in order for the filter to match (logical "and" - between different filter attributes). If an attribute is an - array, the attribute shall match if at least one of the - values in the array matches (logical "or" between the - values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to - match NFV-MANO functional entities and their associated - managed objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and - "manoServiceNames" are alternatives to reference to - NFV-MANO services in a filter. They should not be - used together in the same filter instance, but one - alternative should be chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance identifier - listed in this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective - type within a NFV-MANO functional entity, but that - need not be globally unique. Representation: - string of variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity - produced interfaces with an instance Name listed in - this attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance identifier - listed in this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity - consumed interfaces with an instance Name listed in - this attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" - attribute are spelled exactly as the names of the - notification types to facilitate automated code - generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - The URI of the endpoint to send the notification to. - type: object - properties: - links: - description: | - String formatted according to IETF RFC 3986. - type: string - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - links - - self - required: - - id - - callbackUri - subscriptions.get.400: - description: | - 400 BAD REQUEST - Shall be returned upon the following errors: - - Invalid attribute-based filtering expression. - The response body shall contain a ProblemDetails structure, in which - the "detail" attribute should convey more information about the error. - - Response too big. - If the NFV-MANO functional entity supports alternative N°1 (error) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, - this error response shall follow the provisions in clause 5.4.2.2 of - ETSI GS NFV-SOL 013. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis 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: - - status - - 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 - subscription.get.200: - description: > - 200 OK - - Shall be returned when the subscription has been read successfully. - - The response body shall contain a representation of the "Individual - subscription" resource, as defined in clause 6.6.2.3. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - content: - application/json: - schema: - description: | - This type represents a subscription. - type: object - properties: - id: - description: | - An identifier with the intention of being globally unique. - type: string - filter: - description: > - This type represents a filter that can be used to subscribe - for notifications related to performance management events. - At a particular nesting level in the filter structure, the - following applies: All attributes shall match in order for - the filter to match (logical "and" between different filter - attributes). If an attribute is an array, the attribute shall - match if at least one of the values in the array matches - (logical "or" between the values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" attribute - are spelled exactly as the names of the notification - types to facilitate automated code generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - The URI of the endpoint to send the notification to. - type: object - properties: - links: - description: | - String formatted according to IETF RFC 3986. - type: string - self: - description: > - This type represents a link to a resource using an - absolute URI. - type: object - required: - - href - properties: - href: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - links - - self - required: - - id - - callbackUri - subscription.delete.204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has been - deleted successfully. - - The response body shall be empty. - headers: - 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. - schema: - type: string - Version: - description: | - Version of the API used in the response. - schema: - type: string - parameters: - filter.PmJob: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the PmJob and in data types - referenced from it shall be supported by the NFV-MANO functional entity - in the expression. - in: query - required: false - schema: - type: string - filter.Threshold: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the Threshold and in data types - referenced from it shall be supported by the NFV-MANO functional entity - in the expression. - in: query - required: false - schema: - type: string - filter.PmSubscription: - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS - NFV-SOL 013. - - The NFV-MANO functional entity shall support receiving this parameter - as part of the URI query string. The API consumer may supply this - parameter. - - All attribute names that appear in the PmSubscription and in data - types referenced from it shall be supported by the NFV-MANO functional - entity in the expression. - in: query - required: false - schema: - type: string - exclude_default.PmJob: - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the - response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The - NFV-MANO functional entity shall support this parameter. - - The following attributes shall be excluded from the PmJob structure in - the response body if this parameter is provided, or none of the - parameters "all_fields," "fields", "exclude_fields", "exclude_default" - are provided: - none - in: query - required: false - schema: - type: string - subscriptionId: - name: subscriptionId - in: path - description: Identifier of the subscription - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - pmJobId: - name: pmJobId - in: path - description: Identifier of the PM Job - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - reportId: - name: reportId - in: path - description: Identifier of the PM report - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - thresholdId: - name: thresholdId - in: path - description: Identifier of the PM threshold - required: true - schema: - description: | - An identifier with the intention of being globally unique. - type: string - requestBodies: - CreatePMJobRequest: - description: | - PM job creation request. - content: - application/json: - schema: - description: | - This type represents a request to create a PM job. - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA - 031. - type: string - objectInstanceIds: - description: > - Identifiers of the measured object instance for which - performance information is requested to be collected. This - attribute shall contain the identifier of the instance of the - measure object according to their type. See also definitions - in clause 8.2 of ETSI GS NFV-IFA 031. If more than one - identifier is provided, values shall all refer to measured - object instances of the same type, for which the same criteria - is then applicable. - type: array - items: - description: | - An identifier with the intention of being globally unique. - type: string - minItems: 1 - subObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance for which performance information is requested to be - collected. May be present if a sub-object is defined in - clause 8.2 of ETSI GS NFV-IFA 031 for the related measured - object type. If this attribute is present, the cardinality of - the "objectInstanceIds" attribute shall be 1. If this - attribute is absent and a sub-object is defined in clause 8.2 - of ETSI GS NFV-IFA 031 for the related measured object type, - measurements will be taken for all sub-object instances of - the measured object instance. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - criteria: - description: | - This type represents collection criteria for PM jobs. - type: object - properties: - performanceMetric: - description: > - This defines the types of performance metrics for the - specified measured object(s). This attribute’s value - shall contain the related "Measurement Name" values as - defined in clause 8.4 of ETSI GS NFV-IFA 031. At least - one of the two attributes (performance metric or group) - shall be present. - type: array - items: - type: string - performanceMetricGroup: - description: > - Group of performance metrics. A metric group is a - pre-defined list of metrics, known to the producer that - it can decompose to individual metrics. This attribute’s - value shall contain the related "Measurement Group" - values as defined in clause 8.4 of ETSI GS NFV-IFA 031. - At least one of the two attributes (performance metric or - group) shall be present. - type: array - items: - type: string - collectionPeriod: - description: > - Specifies the periodicity at which the producer will - collect performance information. The unit shall be - seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed collection - period during this reportingPeriod. The reportingPeriod - should be equal to or a multiple of the collectionPeriod. - In the latter case, the performance data for the - collection periods within one reporting period are - reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported - depends on the capability of the producing entity. - type: integer - reportingPeriod: - description: > - Specifies the periodicity at which the producer will - report to the API consumer about performance information. - The unit shall be seconds. - - At the end of each reportingPeriod, the producer will - inform the API consumer about availability of the - performance data collected for each completed collection - period during this reportingPeriod. The reportingPeriod - should be equal to or a multiple of the collectionPeriod. - In the latter case, the performance data for the - collection periods within one reporting period are - reported together. - - In particular when choosing short collection and reporting - periods, the number of PM jobs that can be supported - depends on the capability of the producing entity. - type: integer - reportingBoundary: - description: > - Date-time stamp. Representation: String formatted - according to IETF RFC 3339. - type: string - format: date-time - required: - - collectionPeriod - - reportingPeriod - required: - - objectType - - objectInstanceIds - - criteria - required: true - CreateThesholdRequest: - description: | - Request parameters to create a threshold. - content: - application/json: - schema: - description: | - This type represents a request to create a threshold. - type: object - properties: - objectType: - description: > - Type of measured object. The applicable measured object type - for a measurement is defined in clause 8.2 of ETSI GS NFV-IFA - 031. - type: string - objectInstanceId: - description: | - An identifier with the intention of being globally unique. - type: string - subjObjectInstanceIds: - description: > - Identifiers of the sub-object instances of the measured object - instance associated with this threshold. May be present if a - sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for - the related measured object type. If this attribute is absent - and a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA - 031 for the related measured object type, thresholds will be - set for all sub-object instances of the measured object - instance. - type: array - items: - description: > - An identifier that is unique for the respective type within - a NFV-MANO functional entity, but that need not be globally - unique. Representation: string of variable length.. - type: string - criteria: - description: | - This type represents criteria that define a threshold. - type: object - properties: - performanceMetric: - description: > - Defines the performance metric associated with the - threshold. This attribute’s value shall contain the - related "Measurement Name" values as defined in clause - 8.4 of ETSI GS NFV-IFA 031 - type: string - thresholdType: - description: > - Type of threshold. This attribute determines which other - attributes are present in the data structure. Permitted - values: - - SIMPLE: Single-valued static threshold - - In the present document, simple thresholds are defined. - The definition of additional threshold types is left for - future specification. - type: string - enum: - - SIMPLE - simpleThresholdDetails: - description: > - Details of a simple threshold. Shall be present if - thresholdType="SIMPLE". - type: object - properties: - thresholdValue: - description: | - A number defined in IETF RFC 8259. - type: number - hysteresis: - description: | - A number defined in IETF RFC 8259. - type: number - required: - - thresholdValue - - hysteresis - required: - - performanceMetric - - thresholdType - required: - - objectType - - objectInstanceId - - criteria - required: true - CreateSubscriptionRequest: - description: | - Details of the subscription to be created. - content: - application/json: - schema: - description: | - This type represents a subscription request. - type: object - properties: - filter: - description: > - This type represents a filter that can be used to subscribe - for notifications related to performance management events. - At a particular nesting level in the filter structure, the - following applies: All attributes shall match in order for - the filter to match (logical "and" between different filter - attributes). If an attribute is an array, the attribute shall - match if at least one of the values in the array matches - (logical "or" between the values of one filter attribute). - type: object - properties: - pmSubscriptionFilter: - description: > - This type represents subscription filter criteria to match - NFV-MANO functional entities and their associated managed - objects. - type: object - properties: - manoEntityId: - description: > - An identifier with the intention of being globally - unique. - type: string - manoServiceIds: - description: "manoServiceIds\tIdentifierInManoEntity\t0..N\tIf present, match NFV-MANO services with an instance identifier listed in this attribute.\nThe attributes \"manoServiceIds\" and \"manoServiceNames\" are alternatives to reference to NFV-MANO services in a filter. They should not be used together in the same filter instance, but one alternative should be chosen.\n" - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceNames: - description: > - If present, match NFV-MANO services with an NFV-MANO - service name listed in this attribute. - - The attributes "manoServiceIds" and "manoServiceNames" - are alternatives to reference to NFV-MANO services in - a filter. They should not be used together in the - same filter instance, but one alternative should be - chosen. - type: array - items: - type: string - manoServiceInterfaceIds: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance identifier listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier that is unique for the respective type - within a NFV-MANO functional entity, but that need - not be globally unique. Representation: string of - variable length.. - type: string - manoServiceInterfaceNames: - description: > - If present, match NFV-MANO functional entity produced - interfaces with an instance Name listed in this - attribute. - - The attributes "manoServiceInterfaceIds" and - "manoServiceInterfaceNames" are alternatives to - reference to NFV-MANO functional entity produced - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - consumedManoInterfaceIds: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance identifier listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - description: > - An identifier with the intention of being globally - unique. - type: string - consumedManoInterfaceNames: - description: > - If present, match NFV-MANO functional entity consumed - interfaces with an instance Name listed in this - attribute. - - The attributes "consumedManoInterfaceIds" and - "consumedManoInterfaceNames" are alternatives to - reference to NFV-MANO functional entity consumed - interfaces in a filter. They should not be used both - in the same filter instance, but one alternative - should be chosen. - type: array - items: - type: string - notificationTypes: - description: > - Match particular notification types. Permitted values: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - - The permitted values of the "notificationTypes" attribute - are spelled exactly as the names of the notification - types to facilitate automated code generation systems. - type: string - enum: - - ThresholdCrossedNotification - - PerformanceInformationAvailableNotification - callbackUri: - description: | - String formatted according to IETF RFC 3986. - type: string - authentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which - 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 the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - 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. - type: object - 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: - 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. - type: object - 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. The clientId and clientPassword passed in - a subscription shall not be the same as the clientId - and clientPassword that are used to obtain - authorization for API requests. Client credentials may - differ between subscriptions. The value of - clientPassword should be generated by a random - process. - 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. - The clientId and clientPassword passed in a - subscription shall not be the same as the clientId and - clientPassword that are used to obtain authorization - for API requests. Client credentials may differ - between subscriptions. The value of clientPassword - should be generated by a random process. - type: string - tokenEndpoint: - description: | - String formatted according to IETF RFC 3986. - type: string - required: - - callbackUri - required: true - -- GitLab From c639f23bc62396f0ad6874150bb240759286577a Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Mon, 25 Oct 2021 10:16:32 +0500 Subject: [PATCH 22/22] delete unused variables from variables.txt file --- .../environment/variables.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt index 887bff0d9..1a2939584 100644 --- a/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt +++ b/SOL009/NFVManoConfigurationAndInformationManagement-API/environment/variables.txt @@ -5,17 +5,17 @@ ${NFVMANO_SCHEMA} https ${AUTHORIZATION_TOKEN} Bearer 0b79bab50daca910b000d4f1a2b675d604257e42 ${NEG_AUTHORIZATION_TOKEN} Bearer negativetoken -#${WRONG_AUTHORIZATION_TOKEN} Bearer XXXXXWRONGXXXXX + ${BAD_AUTHORIZATION_TOKEN} Bear sometoken ${CONTENT_TYPE_JSON} application/json ${ACCEPT_JSON} application/json ${CONTENT_TYPE_PATCH} application/merge-patch+json ${AUTH_USAGE} 1 -#${FIELD_USAGE} 1 + ${NFVMANO_CHECKS_NOTIF_ENDPOINT} 1 ## If true, during subscription, the FUT performs a get to the notification endpoint -#${NFVMANO_ALLOWS_DUPLICATE_SUBS} 1 + ${apiRoot} / ${apiMajorVersion} v2 @@ -41,8 +41,8 @@ ${callback_endpoint} /subscriptions ${filter_ok} callbackUri=${callbackUri} ${filter_ko} erroneousFilter=erroneous ${callback_endpoint_fwd} /endpoint/check -#${callback_endpoint_error} /subs_404 -#${sleep_interval} 20s + + ${total_polling_time} 2 min ${polling_interval} 10 sec -- GitLab