{ "openapi": "3.0.1", "info": { "title": "TMF 653 Service Test Management", "description": "## TMF API Reference: TMF653 - Service Test Management ### Release : 20.0 - April 2020 Service Test Management API goal is to provide the ability to manage tests of provisioned Services. ### Resource - ServiceTest - ServiceTestSpecification ### Operations Service Test Management API performs the following operations on the resources : - Retrieve an entity or a collection of entities depending on filter criteria - Partial update of an entity (including updating rules) - Create an entity (including default values and creation rules) - Delete an entity (for administration purposes) - Manage notification of events", "license": { "name": "Apache 2.0", "url": "https://osl.etsi.org" }, "version": "4.0.0" }, "externalDocs": { "description": "TMF API Tables", "url": "https://www.tmforum.org/oda/open-apis/table" }, "servers": [ { "url": "https://portal.openslice.eu/tmf-api", "description": "Generated server url" } ], "security": [ { "security_auth": [] } ], "tags": [ { "name": "serviceTestSpecification", "description": "the serviceTestSpecification API" }, { "name": "listener", "description": "the listener API" }, { "name": "hub", "description": "the hub API" }, { "name": "serviceTest", "description": "the serviceTest API" } ], "paths": { "/serviceTestManagement/v4/serviceTest": { "get": { "tags": [ "serviceTest" ], "summary": "List or find ServiceTest objects", "description": "This operation list or find ServiceTest entities", "operationId": "listServiceTest", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTest" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTest" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTest" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTest" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTest" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTest" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTest" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTest" } } } } } } }, "post": { "tags": [ "serviceTest" ], "summary": "Creates a ServiceTest", "description": "This operation creates a ServiceTest entity.", "operationId": "createServiceTest", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } } } } }, "/serviceTestManagement/v4/serviceTestSpecification": { "get": { "tags": [ "serviceTestSpecification" ], "summary": "List or find ServiceTestSpecification objects", "description": "This operation list or find ServiceTestSpecification entities", "operationId": "listServiceTestSpecification", "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated properties to be provided in response", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Requested index for start of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Requested number of resources to be provided in response", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } } } }, "post": { "tags": [ "serviceTestSpecification" ], "summary": "Creates a ServiceTestSpecification", "description": "This operation creates a ServiceTestSpecification entity.", "operationId": "createServiceTestSpecification", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecificationCreate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "400": { "description": "Created", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } } } }, "/serviceTestManagement/v4/serviceTestSpecification/{id}/attachment": { "post": { "tags": [ "serviceTestSpecification" ], "summary": "Adds an attachment to a ServiceTestSpecification", "description": "This operation adds an attachment to a ServiceTestSpecification and updates partially a ServiceTestSpecification entity", "operationId": "addAttachmentToServiceTestSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceTestSpecification", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "afile" ], "type": "object", "properties": { "afile": { "type": "string", "description": "The Attachment file to be added", "format": "binary" } } } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/Attachment" } } } } } } }, "/serviceTestManagement/v4/listener/serviceTestSpecificationDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceTestSpecificationDeleteEvent", "description": "Example of a client listener for receiving the notification ServiceTestSpecificationDeleteEvent", "operationId": "listenToServiceTestSpecificationDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecificationDeleteEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceTestManagement/v4/listener/serviceTestSpecificationCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceTestSpecificationCreateEvent", "description": "Example of a client listener for receiving the notification ServiceTestSpecificationCreateEvent", "operationId": "listenToServiceTestSpecificationCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecificationCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceTestManagement/v4/listener/serviceTestSpecificationAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceTestSpecificationAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification ServiceTestSpecificationAttributeValueChangeEvent", "operationId": "listenToServiceTestSpecificationAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecificationAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceTestManagement/v4/listener/serviceTestDeleteEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceTestDeleteEvent", "description": "Example of a client listener for receiving the notification ServiceTestDeleteEvent", "operationId": "listenToServiceTestDeleteEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestDeleteEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceTestManagement/v4/listener/serviceTestCreateEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceTestCreateEvent", "description": "Example of a client listener for receiving the notification ServiceTestCreateEvent", "operationId": "listenToServiceTestCreateEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestCreateEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceTestManagement/v4/listener/serviceTestAttributeValueChangeEvent": { "post": { "tags": [ "listener", "notification listeners (client side)" ], "summary": "Client listener for entity ServiceTestAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification ServiceTestAttributeValueChangeEvent", "operationId": "listenToServiceTestAttributeValueChangeEvent", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestAttributeValueChangeEvent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceTestManagement/v4/hub": { "post": { "tags": [ "hub", "events subscription" ], "summary": "Register a listener", "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "registerListener", "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscriptionInput" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "400": { "description": "Subscribed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/EventSubscription" } } } } } } }, "/serviceTestManagement/v4/serviceTestSpecification/{id}": { "get": { "tags": [ "serviceTestSpecification" ], "summary": "Retrieves a ServiceTestSpecification by ID", "description": "This operation retrieves a ServiceTestSpecification entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveServiceTestSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceTestSpecification", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } } }, "delete": { "tags": [ "serviceTestSpecification" ], "summary": "Deletes a ServiceTestSpecification", "description": "This operation deletes a ServiceTestSpecification entity.", "operationId": "deleteServiceTestSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceTestSpecification", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "serviceTestSpecification" ], "summary": "Updates partially a ServiceTestSpecification", "description": "This operation updates partially a ServiceTestSpecification entity.", "operationId": "patchServiceTestSpecification", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceTestSpecification", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecificationUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestSpecification" } } } } } } }, "/serviceTestManagement/v4/serviceTest/{id}": { "get": { "tags": [ "serviceTest" ], "summary": "Retrieves a ServiceTest by ID", "description": "This operation retrieves a ServiceTest entity. Attribute selection is enabled for all first level attributes.", "operationId": "retrieveServiceTest", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceTest", "required": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Comma-separated properties to provide in response", "required": false, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "200": { "description": "Success", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } } } }, "delete": { "tags": [ "serviceTest" ], "summary": "Deletes a ServiceTest", "description": "This operation deletes a ServiceTest entity.", "operationId": "deleteServiceTest", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceTest", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "204": { "description": "Deleted" }, "409": { "description": "Conflict" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "405": { "description": "Method Not allowed" }, "401": { "description": "Unauthorized" } } }, "patch": { "tags": [ "serviceTest" ], "summary": "Updates partially a ServiceTest", "description": "This operation updates partially a ServiceTest entity.", "operationId": "patchServiceTest", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ServiceTest", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTestUpdate" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "200": { "description": "Updated", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "403": { "description": "Forbidden", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "400": { "description": "Bad Request", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "405": { "description": "Method Not allowed", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/ServiceTest" } } } } } } }, "/serviceTestManagement/v4/serviceTestSpecification/{id}/attachment/{attid}": { "get": { "tags": [ "serviceTestSpecification" ], "summary": "Get an attachment", "description": "This operation gets an attachment", "operationId": "getAttachment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the serviceTestSpecification", "required": true, "schema": { "type": "string" } }, { "name": "attid", "in": "path", "description": "Identifier of the Attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "409": { "description": "Conflict", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "405": { "description": "Method Not allowed", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } } } }, "/serviceTestManagement/v4/serviceTestSpecification/{id}/attachment/{attid}/{afilename}": { "get": { "tags": [ "serviceTestSpecification" ], "summary": "Get an attachment with filename", "description": "This operation gets an attachment", "operationId": "getAttachmentWithFilename", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the serviceTestSpecification", "required": true, "schema": { "type": "string" } }, { "name": "attid", "in": "path", "description": "Identifier of the Attachment", "required": true, "schema": { "type": "string" } }, { "name": "afilename", "in": "path", "description": "Identifier of the Filename", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "409": { "description": "Conflict", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "405": { "description": "Method Not allowed", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } } } }, "/serviceTestManagement/v4/hub/{id}": { "delete": { "tags": [ "hub", "events subscription" ], "summary": "Unregister a listener", "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "operationId": "unregisterListener", "parameters": [ { "name": "id", "in": "path", "description": "The id of the registered listener", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "400": { "description": "Bad request" }, "204": { "description": "Deleted" }, "405": { "description": "Method not allowed" }, "404": { "description": "Not Found" }, "403": { "description": "Forbidden" }, "401": { "description": "Unauthorized" } } } } }, "components": { "schemas": { "Any": { "type": "object", "properties": { "value": { "type": "string" }, "alias": { "type": "string" } } }, "AppliedConsequence": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "A word, term, or phrase by which Consequence is known and distinguished from other MetricDefMeasureConsequences." }, "appliedAction": { "type": "string", "description": "The action for a violated threshold. This could be a hyperlink to the action." }, "description": { "type": "string", "description": "A narrative that explains in detail what the consequence is." }, "repeatAction": { "type": "boolean", "description": "An indicator used to specify that a consequence should cease being applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. If the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." } }, "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a MeasureThresholdRuleViolation occurs." }, "Characteristic": { "required": [ "name", "value" ], "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the characteristic" }, "id": { "type": "string" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/CharacteristicRelationship" } }, "value": { "$ref": "#/components/schemas/Any" } }, "description": "Describes a given characteristic of an object or entity through a name/value pair." }, "CharacteristicRelationship": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "id": { "type": "string" }, "relationshipType": { "type": "string", "description": "The type of relationship" } }, "description": "Another Characteristic that is related to the current Characteristic;" }, "Duration": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "amount": { "type": "integer", "description": "Time interval (number of seconds, minutes, hours, etc.)", "format": "int32" }, "units": { "type": "string", "description": "Unit of time (seconds, minutes, hours, etc.)" } }, "description": "A time interval in a given unit of time" }, "MeasureThresholdRuleViolation": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name for the MetricDefMeasureThresholdRule ." }, "conformanceComparatorLower": { "type": "string", "description": "An operator that when applied on a value specifies whether a threshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetLower." }, "conformanceComparatorUpper": { "type": "string", "description": "An operator that when applied on a value specifies whether a threshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." }, "conformanceTargetExact": { "type": "string", "description": "to cater for values that are not numerical test metrics (e.g. a DSL line can be Synchronised or Unsynchronised. If the latter, the test should result in a rule violation).The allowed value can contain a REGEX string." }, "conformanceTargetLower": { "type": "string", "description": "A value used to determine if the threshold is crossed or ceases to be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." }, "conformanceTargetUpper": { "type": "string", "description": "A value used to determine if the threshold is crossed or ceases to be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." }, "description": { "type": "string", "description": "Description for the MetricDefMeasureThresholdRule ." }, "numberOfAllowedCrossing": { "type": "integer", "description": "The number of allowed crossing occurrences in reference to the tolerancePeriod without a consequence being initiated.", "format": "int32" }, "thresholdRuleSeverity": { "type": "string", "description": "A threshold can be generated in different severity levels. A crossing for each level may require a different condition and possibly trigger a different consequence." }, "appliedConsequence": { "uniqueItems": true, "type": "array", "description": "An Applied Consequence defines the action (prescribed action or notification) to take when a MeasureThresholdRuleViolation occurs.", "items": { "$ref": "#/components/schemas/AppliedConsequence" } }, "tolerancePeriod": { "$ref": "#/components/schemas/Duration" } }, "description": "A measureThresholdRuleViolation is a violation of a rule that defines the in the MericDefMeasureThresholdRule." }, "RelatedParty": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "role": { "type": "string", "description": "Role of the related party." }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" }, "extendedInfo": { "type": "string" } }, "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity." }, "ServiceRef": { "required": [ "id" ], "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string", "description": "Id of the service" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "description": "Service reference, for when Service is used by other entities" }, "ServiceTestCreate": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "The end date and time of the service test" }, "startDateTime": { "type": "string", "description": "The start date and time of the service test." }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "description": { "type": "string", "description": "Description of the service test" }, "mode": { "type": "string", "description": "An indication of whether the service test is running in \"PROACTIVE\" or \"ONDEMAND\" mode" }, "name": { "type": "string", "description": "The name of the service test" }, "state": { "type": "string", "description": "The actual state the service test is in" }, "characteristic": { "type": "array", "description": "List of characteristics with values that define the test run", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "type": "array", "description": "Party related to the test", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "relatedService": { "$ref": "#/components/schemas/ServiceRef" }, "testMeasure": { "type": "array", "description": "The results of the test in terms of the measured metrics", "items": { "$ref": "#/components/schemas/TestMeasure" } }, "testSpecification": { "$ref": "#/components/schemas/ServiceTestSpecificationRef" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The ServiceTest to be created" }, "ServiceTestSpecificationRef": { "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Hyperlink to access a service test specification." }, "id": { "type": "string" }, "version": { "type": "string", "description": "Version of a service test specification " }, "@referredType": { "type": "string" } }, "description": "The service test specification used by the service test." }, "TestMeasure": { "type": "object", "properties": { "uuid": { "type": "string" }, "captureDateTime": { "type": "string", "description": "The date and time that the metric was captured" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "accuracy": { "type": "number", "description": "The number of digits of accuracy captured for associated Metrics", "format": "float" }, "captureMethod": { "type": "string", "description": "The method used to capture the Metrics (This may be replaced by a set of entities similar to the Performance Monitoring Ref)" }, "metricDescription": { "type": "string", "description": "Brief description of the metric" }, "metricHref": { "type": "string", "description": "Hyperlink to access a metric for detail information" }, "metricName": { "type": "string", "description": "The name of the metric" }, "unitOfMeasure": { "type": "string", "description": "The unit of measure for the metric values, such as meters, cubic yards, kilograms [ISO 1000]." }, "ruleViolation": { "uniqueItems": true, "type": "array", "description": "A list of rules that were violated in this test measure", "items": { "$ref": "#/components/schemas/MeasureThresholdRuleViolation" } }, "value": { "$ref": "#/components/schemas/Characteristic" } }, "description": "A TestMeasure specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status" }, "TimePeriod": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "type": "string", "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end" } }, "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both" }, "ServiceTest": { "type": "object", "properties": { "uuid": { "type": "string" }, "lastUpdate": { "type": "string", "description": "Date and time of the last update" }, "endDateTime": { "type": "string", "description": "The end date and time of the service test" }, "startDateTime": { "type": "string", "description": "The start date and time of the service test." }, "lifecycleStatusEnum": { "type": "string", "writeOnly": true, "enum": [ "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected" ] }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "The name of the service test" }, "description": { "type": "string", "description": "Description of the service test" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Entity version" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "id": { "type": "string" }, "mode": { "type": "string", "description": "An indication of whether the service test is running in \"PROACTIVE\" or \"ONDEMAND\" mode" }, "state": { "type": "string", "description": "The actual state the service test is in" }, "characteristic": { "uniqueItems": true, "type": "array", "description": "List of characteristics with values that define the test run", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "uniqueItems": true, "type": "array", "description": "Party related to the test", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "relatedService": { "$ref": "#/components/schemas/ServiceRef" }, "testMeasure": { "uniqueItems": true, "type": "array", "description": "The results of the test in terms of the measured metrics", "items": { "$ref": "#/components/schemas/TestMeasure" } }, "testSpecification": { "$ref": "#/components/schemas/ServiceTestSpecificationRef" } }, "description": "A service test is an entity that exists for a controlled test invocation on a service. The service test is executed according to a schedule and contains service test configuration parameters that are to be applied at execution time, and service test measures that result." }, "AssociationSpecificationRef": { "required": [ "id" ], "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "id": { "type": "string", "description": "unique identifier" }, "@referredType": { "type": "string" } }, "description": "reference to an AssociationSpecification object" }, "AttachmentRefOrValue": { "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string", "description": "Unique identifier for this particular attachment", "example": "4aafacbd-11ff-4dc8-b445-305f2215715f" }, "attachmentType": { "type": "string", "description": "Attachment type such as video, picture", "example": "video" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment", "example": "Photograph of the Product" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "url": { "type": "string", "description": "Uniform Resource Locator, is a web page address (a subset of URI)", "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "size": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@referredType": { "type": "string" } }, "description": "An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture." }, "CharacteristicSpecification": { "type": "object", "properties": { "uuid": { "type": "string" }, "atValueSchemaLocation": { "type": "string", "description": "This (optional) field provides a link to the schema describing the value type." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." }, "id": { "type": "string", "description": "Unique ID for the characteristic" }, "configurable": { "type": "boolean", "description": "If true, the Boolean indicates that the target Characteristic is configurable" }, "description": { "type": "string", "description": "A narrative that explains the CharacteristicSpecification." }, "extensible": { "type": "boolean", "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource." }, "isUnique": { "type": "boolean", "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" }, "maxCardinality": { "type": "integer", "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality.", "format": "int32" }, "minCardinality": { "type": "integer", "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality.", "format": "int32" }, "regex": { "type": "string", "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." }, "valueType": { "type": "string", "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "charSpecRelationship": { "uniqueItems": true, "type": "array", "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.", "items": { "$ref": "#/components/schemas/CharacteristicSpecificationRelationship" } }, "characteristicValueSpecification": { "uniqueItems": true, "type": "array", "description": "A CharacteristicValueSpecification object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a CharacteristicSpecification object. The values of the attributes in the CharacteristicValueSpecification object describe the values of the attributes that a corresponding Characteristic object can take on.", "items": { "$ref": "#/components/schemas/CharacteristicValueSpecification" } }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@valueSchemaLocation": { "type": "string" } }, "description": "This class defines a characteristic specification." }, "CharacteristicSpecificationRelationship": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "characteristicSpecificationId": { "type": "string", "description": "Unique identifier of the characteristic within the specification" }, "parentSpecificationHref": { "type": "string", "description": "Hyperlink reference to the parent specification containing the target characteristic" }, "parentSpecificationId": { "type": "string", "description": "Unique identifier of the parent specification containing the target characteristic" }, "relationshipType": { "type": "string", "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID." }, "CharacteristicValueSpecification": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "isDefault": { "type": "boolean", "description": "If true, the Boolean Indicates if the value is the default value for a characteristic" }, "rangeInterval": { "type": "string", "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." }, "regex": { "type": "string", "description": "A regular expression constraint for given value" }, "unitOfMeasure": { "type": "string", "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." }, "valueFrom": { "type": "integer", "description": "The low range value that a characteristic can take on", "format": "int32" }, "valueTo": { "type": "integer", "description": "The upper range value that a characteristic can take on", "format": "int32" }, "valueType": { "type": "string", "description": "A kind of value that the characteristic value can take on, such as numeric, text and so forth" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "value": { "$ref": "#/components/schemas/Any" } }, "description": "specification of a value (number or text or an object) that can be assigned to a Characteristic." }, "ConstraintRef": { "required": [ "id" ], "type": "object", "properties": { "uuid": { "type": "string" }, "atReferredType": { "type": "string", "description": "The (class) type of the referred constraint" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Hyperlink reference to the target constraint" }, "name": { "type": "string", "description": "Name given to the constraint" }, "id": { "type": "string", "description": "reference id to the target constraint" }, "@referredType": { "type": "string" }, "version": { "type": "string" } }, "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec." }, "EntitySpecificationRelationship": { "required": [ "relationshipType" ], "type": "object", "properties": { "uuid": { "type": "string" }, "lastUpdate": { "type": "string", "description": "Date and time of the last update" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "lifecycleStatusEnum": { "type": "string", "writeOnly": true, "enum": [ "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected" ] }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Entity version" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "id": { "type": "string", "description": "unique identifier" }, "relationshipType": { "type": "string", "description": "Type of relationship such as migration, substitution, dependency, exclusivity" }, "role": { "type": "string", "description": "The association role for this entity specification" }, "associationSpec": { "$ref": "#/components/schemas/AssociationSpecificationRef" }, "@referredType": { "type": "string" } }, "description": "A migration, substitution, dependency or exclusivity relationship between/among entity specifications." }, "MetricDefMeasureConsequence": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "A word, term, or phrase by which a MetricDefMeasureConsequence is known and distinguished from other MetricDefMeasureConsequences." }, "description": { "type": "string", "description": "A narrative that explains in detail what the consequence is." }, "prescribeAction": { "type": "string", "description": "Recommended remedy for a violated threshold. This could be the hyperlink to the action." }, "repeatAction": { "type": "boolean", "description": "An indicator used to specify that a consequence should cease being applied if a value is in the same range as the previous value or continue being applied if a value is in the same range as the previous value. If the repeatAction is True, if the consequence is always applied as soon as the MetricMeasure value is in the range of values and if the repeatAction is False, the consequence is applied only if the previous MetricMeasure value was not in the same range." }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "A MetricDefMeasureConsequence defines the action (prescribed action or notification) to take when a MetricDefMeasureThresholdRule is crossed." }, "MetricDefMeasureThresholdRule": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name for the MetricDefMeasureThresholdRule ." }, "conformanceComparatorLower": { "type": "string", "description": "An operator that when applied on a value specifies whether a threshold is crossed or ceased to be crossed. This operator is used to Service Test Management API REST Specification compare with the conformanceTargetLower." }, "conformanceComparatorUpper": { "type": "string", "description": "An operator that when applied on a value specifies whether a threshold is crossed or ceased to be crossed. This operator is used to compare with the conformanceTargetUpper." }, "conformanceTargetLower": { "type": "string", "description": "A value used to determine if the threshold is crossed or ceases to be crossed. It represents the lower limit. The value should be less than the conformanceTargetUpper. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." }, "conformanceTargetUpper": { "type": "string", "description": "A value used to determine if the threshold is crossed or ceases to be crossed. It represents the Upper limit. The value should be greater than the conformanceTargetLower. The conformance comparators should also be logically defined so as to not lead to a logically impossible condition." }, "description": { "type": "string", "description": "Description for the MetricDefMeasureThresholdRule ." }, "numberOfAllowedCrossing": { "type": "integer", "description": "The number of allowed crossing occurrences in reference to the tolerancePeriod without a consequence being initiated.", "format": "int32" }, "thresholdRuleSeverity": { "type": "string", "description": "A threshold can be generated in different severity levels. A crossing for each level may require a different condition and possibly trigger a different consequence." }, "consequence": { "uniqueItems": true, "type": "array", "description": "A list of consequences (actions, notifications) that will arise if the threshold is crossed", "items": { "$ref": "#/components/schemas/MetricDefMeasureConsequence" } }, "tolerancePeriod": { "$ref": "#/components/schemas/Duration" } }, "description": "A MetricDefMeasureThresholdRule is a rule that defines the condition (raise or clear) to achieve to apply consequences when a threshold is crossed or ceased to be crossed. It also defines the severity of the raise or clear of the threshold." }, "Quantity": { "type": "object", "properties": { "amount": { "type": "number", "description": "Numeric value in a given unit", "format": "float" }, "units": { "type": "string", "description": "Unit" } }, "description": "An amount in a given unit" }, "ServiceSpecificationRef": { "type": "object", "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "version": { "type": "string", "description": "Service specification version" }, "targetServiceSchema": { "$ref": "#/components/schemas/TargetServiceSchema" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "id": { "type": "string" } }, "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification." }, "ServiceTestSpecRelationship": { "required": [ "relationshipType" ], "type": "object", "properties": { "uuid": { "type": "string" }, "lastUpdate": { "type": "string", "description": "Date and time of the last update" }, "atReferredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." }, "lifecycleStatusEnum": { "type": "string", "writeOnly": true, "enum": [ "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected" ] }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Entity version" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "id": { "type": "string" }, "relationshipType": { "type": "string", "description": "Type of relationship such as substitution, dependency, exclusivity" }, "role": { "type": "string", "description": "The association role for this service test specification" }, "@referredType": { "type": "string" } }, "description": "A substitution, dependency or exclusivity relationship between/among service specifications." }, "ServiceTestSpecificationCreate": { "type": "object", "properties": { "lastUpdate": { "type": "string", "description": "Date and time of the last update of this REST resource" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "description": { "type": "string", "description": "Description of a service test specification." }, "isBundle": { "type": "boolean", "description": "isBundle determines whether an EntitySpecification represents a single EntitySpecification (false), or a bundle of EntitySpecifications (true)." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this catalog item" }, "name": { "type": "string", "description": "Name given to this REST resource" }, "version": { "type": "string", "description": "Entity specification version" }, "attachment": { "type": "array", "description": "Attachments that may be of relevance to this specification, such as picture, document, media", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "constraint": { "type": "array", "description": "This is a list of constraint references applied to this specification", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "entitySpecRelationship": { "type": "array", "description": "Relationship to another entity specification, might be dependency, substitution, etc.", "items": { "$ref": "#/components/schemas/EntitySpecificationRelationship" } }, "relatedParty": { "type": "array", "description": "Parties who manage or otherwise have an interest in this entity specification", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "relatedServiceSpecification": { "type": "array", "description": "The related service specification may relate to more than one service specification.", "items": { "$ref": "#/components/schemas/ServiceSpecificationRef" } }, "serviceTestSpecRelationship": { "type": "array", "description": "A list of service test specifications related to this specification e.g. dependency, substitution", "items": { "$ref": "#/components/schemas/ServiceTestSpecRelationship" } }, "specCharacteristic": { "type": "array", "description": "List of characteristics that the entity can take", "items": { "$ref": "#/components/schemas/CharacteristicSpecification" } }, "targetEntitySchema": { "$ref": "#/components/schemas/TargetEntitySchema" }, "testMeasureDefinition": { "type": "array", "description": "A list of definitions for the measurements for the test defined by this specification", "items": { "$ref": "#/components/schemas/TestMeasureDefinition" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "The ServiceTestSpecification to be created" }, "TargetEntitySchema": { "required": [ "atSchemaLocation", "atType" ], "type": "object", "properties": { "uuid": { "type": "string" }, "atSchemaLocation": { "type": "string", "description": "This field provides a link to the schema describing the target entity" }, "atType": { "type": "string", "description": "Class type of the target entity" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" } }, "description": "The reference object to the schema and type of target entity which is described by a specification" }, "TargetServiceSchema": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" } }, "description": "The reference object to the schema and type of target service which is described by service specification" }, "TestMeasureDefinition": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "The name of the TestMeasureDefinition" }, "captureFrequency": { "type": "string", "description": "The frequency of capture for the metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" }, "captureMethod": { "type": "string", "description": "The method used to capture the Metric. Note: This may be replaced by a set of entities similar to the Performance Monitoring" }, "metricDescription": { "type": "string", "description": "Brief description of the metric" }, "metricHref": { "type": "string", "description": "Hyperlink to access a metric for detail information" }, "metricName": { "type": "string", "description": "The name of a metric that in the test measure" }, "unitOfMeasure": { "type": "string", "description": "Name of a service test specification" }, "valueType": { "type": "string", "description": "A kind of value that the Metric value can take on, such as numeric, text, and so forth" }, "capturePeriod": { "$ref": "#/components/schemas/Duration" }, "thresholdRule": { "uniqueItems": true, "type": "array", "description": "The rule(s) associated with the measure threshold", "items": { "$ref": "#/components/schemas/MetricDefMeasureThresholdRule" } }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "A TestMeasureDefinition specifies a measure of a specific aspect of a product, service, or resource test, such as lost packets or connectivity status" }, "ServiceTestSpecification": { "type": "object", "properties": { "uuid": { "type": "string" }, "lastUpdate": { "type": "string", "description": "Date and time of the last update" }, "lifecycleStatusEnum": { "type": "string", "writeOnly": true, "enum": [ "In study", "In design", "In test", "Active", "Launched", "Retired", "Obsolete", "Rejected" ] }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Entity specification version" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "id": { "type": "string" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether an EntitySpecification represents a single EntitySpecification (false), or a bundle of EntitySpecifications (true)." }, "attachment": { "uniqueItems": true, "type": "array", "description": "Attachments that may be of relevance to this specification, such as picture, document, media", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "constraint": { "uniqueItems": true, "type": "array", "description": "This is a list of constraint references applied to this specification", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "entitySpecRelationship": { "uniqueItems": true, "type": "array", "description": "Relationship to another entity specification, might be dependency, substitution, etc.", "items": { "$ref": "#/components/schemas/EntitySpecificationRelationship" } }, "relatedParty": { "uniqueItems": true, "type": "array", "description": "Parties who manage or otherwise have an interest in this entity specification", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "relatedServiceSpecification": { "uniqueItems": true, "type": "array", "description": "The related service specification may relate to more than one service specification.", "items": { "$ref": "#/components/schemas/ServiceSpecificationRef" } }, "serviceTestSpecRelationship": { "uniqueItems": true, "type": "array", "description": "A list of service test specifications related to this specification e.g. dependency, substitution", "items": { "$ref": "#/components/schemas/ServiceTestSpecRelationship" } }, "specCharacteristic": { "uniqueItems": true, "type": "array", "description": "List of characteristics that the entity can take", "items": { "$ref": "#/components/schemas/CharacteristicSpecification" } }, "targetEntitySchema": { "$ref": "#/components/schemas/TargetEntitySchema" }, "testMeasureDefinition": { "uniqueItems": true, "type": "array", "description": "A list of definitions for the measurements for the test defined by this specification", "items": { "$ref": "#/components/schemas/TestMeasureDefinition" } } }, "description": "The service test specification describes the service test in terms of parameters to be configured and measures to be taken." }, "Attachment": { "type": "object", "properties": { "uuid": { "type": "string" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string" }, "href": { "type": "string", "description": "Unique reference of the entity" }, "name": { "type": "string", "description": "Name of the entity" }, "id": { "type": "string", "description": "Unique identifier for this particular attachment" }, "attachmentType": { "type": "string", "description": "Attachment type such as video, picture" }, "content": { "type": "string", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "url": { "type": "string", "description": "Uniform Resource Locator, is a web page address (a subset of URI)" }, "size": { "$ref": "#/components/schemas/Quantity" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "Complements the description of an element (for instance a product) through video, pictures..." }, "ServiceTestSpecificationDeleteEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/ServiceTestSpecificationDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" } }, "description": "The event data" }, "ServiceTestSpecificationDeleteEventPayload": { "type": "object", "properties": { "serviceTestSpecification": { "$ref": "#/components/schemas/ServiceTestSpecification" } }, "description": "The event data structure" }, "EventSubscription": { "required": [ "callback", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Sets the communication endpoint address the service instance must use to deliver notification information" }, "ServiceTestSpecificationCreateEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/ServiceTestSpecificationCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" } }, "description": "The event data" }, "ServiceTestSpecificationCreateEventPayload": { "type": "object", "properties": { "serviceTestSpecification": { "$ref": "#/components/schemas/ServiceTestSpecification" } }, "description": "The event data structure" }, "ServiceTestSpecificationAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/ServiceTestSpecificationAttributeValueChangeEventPayload" } }, "description": "The event data" }, "ServiceTestSpecificationAttributeValueChangeEventPayload": { "type": "object", "properties": { "serviceTestSpecification": { "$ref": "#/components/schemas/ServiceTestSpecification" } }, "description": "The event data structure" }, "ServiceTestDeleteEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/ServiceTestDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" } }, "description": "The event data" }, "ServiceTestDeleteEventPayload": { "type": "object", "properties": { "serviceTest": { "$ref": "#/components/schemas/ServiceTest" } }, "description": "The event data structure" }, "ServiceTestCreateEvent": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/ServiceTestCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" } }, "description": "The event data" }, "ServiceTestCreateEventPayload": { "type": "object", "properties": { "serviceTest": { "$ref": "#/components/schemas/ServiceTest" } }, "description": "The event data structure" }, "ServiceTestAttributeValueChangeEvent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time" }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "$ref": "#/components/schemas/ServiceTestAttributeValueChangeEventPayload" } }, "description": "The event data" }, "ServiceTestAttributeValueChangeEventPayload": { "type": "object", "properties": { "serviceTest": { "$ref": "#/components/schemas/ServiceTest" } }, "description": "The event data structure" }, "EventSubscriptionInput": { "required": [ "callback" ], "type": "object", "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } }, "description": "Data containing the callback endpoint to deliver the information" }, "ServiceTestSpecificationUpdate": { "type": "object", "properties": { "lastUpdate": { "type": "string", "description": "Date and time of the last update of this REST resource" }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "description": { "type": "string", "description": "Description of a service test specification." }, "isBundle": { "type": "boolean", "description": "isBundle determines whether an EntitySpecification represents a single EntitySpecification (false), or a bundle of EntitySpecifications (true)." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this catalog item" }, "name": { "type": "string", "description": "Name given to this REST resource" }, "version": { "type": "string", "description": "Entity specification version" }, "attachment": { "type": "array", "description": "Attachments that may be of relevance to this specification, such as picture, document, media", "items": { "$ref": "#/components/schemas/AttachmentRefOrValue" } }, "constraint": { "type": "array", "description": "This is a list of constraint references applied to this specification", "items": { "$ref": "#/components/schemas/ConstraintRef" } }, "entitySpecRelationship": { "type": "array", "description": "Relationship to another entity specification, might be dependency, substitution, etc.", "items": { "$ref": "#/components/schemas/EntitySpecificationRelationship" } }, "relatedParty": { "type": "array", "description": "Parties who manage or otherwise have an interest in this entity specification", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "relatedServiceSpecification": { "type": "array", "description": "The related service specification may relate to more than one service specification.", "items": { "$ref": "#/components/schemas/ServiceSpecificationRef" } }, "serviceTestSpecRelationship": { "type": "array", "description": "A list of service test specifications related to this specification e.g. dependency, substitution", "items": { "$ref": "#/components/schemas/ServiceTestSpecRelationship" } }, "specCharacteristic": { "type": "array", "description": "List of characteristics that the entity can take", "items": { "$ref": "#/components/schemas/CharacteristicSpecification" } }, "targetEntitySchema": { "$ref": "#/components/schemas/TargetEntitySchema" }, "testMeasureDefinition": { "type": "array", "description": "A list of definitions for the measurements for the test defined by this specification", "items": { "$ref": "#/components/schemas/TestMeasureDefinition" } }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The ServiceTestSpecification to be updated" }, "ServiceTestUpdate": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "The end date and time of the service test" }, "startDateTime": { "type": "string", "description": "The start date and time of the service test." }, "atBaseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "atSchemaLocation": { "type": "string", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "atType": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "description": { "type": "string", "description": "Description of the service test" }, "mode": { "type": "string", "description": "An indication of whether the service test is running in \"PROACTIVE\" or \"ONDEMAND\" mode" }, "name": { "type": "string", "description": "The name of the service test" }, "state": { "type": "string", "description": "The actual state the service test is in" }, "characteristic": { "type": "array", "description": "List of characteristics with values that define the test run", "items": { "$ref": "#/components/schemas/Characteristic" } }, "relatedParty": { "type": "array", "description": "Party related to the test", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "relatedService": { "$ref": "#/components/schemas/ServiceRef" }, "testMeasure": { "type": "array", "description": "The results of the test in terms of the measured metrics", "items": { "$ref": "#/components/schemas/TestMeasure" } }, "testSpecification": { "$ref": "#/components/schemas/ServiceTestSpecificationRef" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "@baseType": { "type": "string" }, "@schemaLocation": { "type": "string" }, "@type": { "type": "string" } }, "description": "The ServiceTest to be updated" } }, "securitySchemes": { "security_auth": { "type": "oauth2", "scheme": "bearer", "bearerFormat": "JWT", "flows": { "authorizationCode": { "authorizationUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/auth", "tokenUrl": "https://portal.openslice.eu/auth/realms/openslice/protocol/openid-connect/token", "scopes": { "read": "read scope", "write": "write scope" } } } } } } }