{ "openapi":"3.0.3", "info":{ "title":"REST API Reference for TDS Microservice", "description":"

\nOracle Communications Solution Test Automation Platform provides APIs for the TDS (Test Data Service) and TES (Test Execution Service) microservices. These APIs allow users to automate, manage, and monitor various aspects of the testing platform in a cloud-native environment.\n

\n\n

\nThe API can perform tasks in the following categories:\n

\n\n", "version":"2026.04.28", "x-summary":"Oracle Communications Solution Test Automation Platform provides APIs for the TDS (Test Data Service) and TES (Test Execution Service) microservices." }, "paths":{ "/action":{ "get":{ "summary":"Get a List of Actions", "description":"Retrieves the list of actions.", "tags":[ "Action" ], "responses":{ "200":{ "description":"The list of actions was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ActionListResponse" } } } } }, "x-internal-id":"action-get", "x-filename-id":"action-get" }, "post":{ "tags":[ "Action" ], "summary":"Create an Action", "description":"Creates a new action.", "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ActionCreate" } } } }, "responses":{ "201":{ "description":"The action was created successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "type":"string", "example":1 } } } } } } }, "x-internal-id":"action-post", "x-filename-id":"action-post" } }, "/action/{id}":{ "get":{ "summary":"Get an Action by ID", "description":"Retrieves the specified action.", "tags":[ "Action" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The action was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Action" } } } }, "404":{ "description":"The action was not found.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"integer", "example":404 }, "error":{ "type":"string", "example":"Data not found with id 20" }, "message":{ "type":"string", "example":"No value present" } } } } } } }, "x-internal-id":"action-{id}-get", "x-filename-id":"action-id-get" }, "delete":{ "summary":"Delete an Action by ID", "description":"Deletes the specified action.", "tags":[ "Action" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The action was deleted successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"SUCCESS" }, "count":{ "type":"integer", "example":1 } } } } } }, "404":{ "description":"The action was not found.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"integer", "example":404 }, "error":{ "type":"string", "example":"Data not found with id 20" }, "message":{ "type":"string", "example":"No value present" } } } } } } }, "x-internal-id":"action-{id}-delete", "x-filename-id":"action-id-delete" } }, "/action/library":{ "get":{ "summary":"Get an Action Library", "description":"Retrieves the action library.", "operationId":"getActionLibrary", "tags":[ "Action" ], "responses":{ "200":{ "description":"The action library was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ActionLibraryResponse" } } } } }, "x-internal-id":"action-library-get", "x-filename-id":"action-library-get" } }, "/action/product":{ "get":{ "summary":"Get an Action Product", "description":"Retrieves the action product.", "operationId":"getActionProduct", "tags":[ "Action" ], "responses":{ "200":{ "description":"The action product was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ActionProductResponse" } } } } }, "x-internal-id":"action-product-get", "x-filename-id":"action-product-get" } }, "/action/product/{productId}":{ "get":{ "summary":"Get Product by ID", "description":"Retrieves the specified product.", "tags":[ "Action" ], "parameters":[ { "$ref":"#/components/parameters/productId" } ], "responses":{ "200":{ "description":"The product was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ActionProductIdResponse" } } } } }, "x-internal-id":"action-product-{productId}-get", "x-filename-id":"action-product-productid-get" } }, "/action/bdd/{bdd}":{ "get":{ "summary":"Get an Action by BDD", "description":"Retrieves the action by its BDD.", "tags":[ "Action" ], "parameters":[ { "$ref":"#/components/parameters/bdd" } ], "responses":{ "200":{ "description":"The action was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ActionBDDResponse" } } } }, "404":{ "description":"The action was not found.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":404 }, "error":{ "type":"string", "example":"Data not found with bdd = " }, "message":{ "type":"string", "example":"No Data found" } } } } } } }, "x-internal-id":"action-bdd-{bdd}-get", "x-filename-id":"action-bdd-bdd-get" } }, "/environment":{ "get":{ "summary":"Get Environment Details", "description":"Retrieves all environments.", "tags":[ "Environment" ], "responses":{ "200":{ "description":"The environment details were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Environments" } } } } }, "x-internal-id":"environment-get", "x-filename-id":"environment-get" }, "post":{ "tags":[ "Environment" ], "summary":"Create an Environment", "description":"Creates the environment.", "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" } } } } } }, "responses":{ "201":{ "description":"The environment was created successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "_id":{ "type":"integer" }, "name":{ "type":"string" }, "connections":{ "type":"integer" }, "description":{ "type":"string" } } } } } } }, "x-internal-id":"environment-post", "x-filename-id":"environment-post" } }, "/environment/{id}":{ "get":{ "summary":"Get Environment Details by ID", "description":"Retrieves the specified environment.", "tags":[ "Environment" ], "parameters":[ { "$ref":"#/components/parameters/Id" }, { "name":"expand", "in":"query", "description":"Set this parameter to true to expand environment details.", "required":false, "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"The environment details were retrieved successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Environment" }, { "$ref":"#/components/schemas/ExpandedEnv" } ] } } } } }, "x-internal-id":"environment-{id}-get", "x-filename-id":"environment-id-get" }, "delete":{ "summary":"Delete an Environment", "description":"Deletes the specified environment.", "tags":[ "Environment" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The environment was deleted successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string" }, "count":{ "type":"integer" } } } } } }, "404":{ "description":"The environment is not found.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":404 }, "error":{ "type":"string", "example":"Data not found to Delete for id" }, "message":{ "type":"string", "example":"No data found to delete" } } } } } } }, "x-internal-id":"environment-{id}-delete", "x-filename-id":"environment-id-delete" } }, "/job":{ "post":{ "summary":"Create a Job", "description":"Creates a job for the given payload.", "tags":[ "Job" ], "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobRequest" } } } }, "responses":{ "201":{ "description":"The job was created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobResponse" } } } } }, "x-internal-id":"job-post", "x-filename-id":"job-post" }, "get":{ "summary":"Get Job Details", "description":"Get details of jobs.", "tags":[ "Job" ], "responses":{ "200":{ "description":"The job details were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Jobs" } } } } }, "x-internal-id":"job-get", "x-filename-id":"job-get" } }, "/job/{id}":{ "get":{ "summary":"Get Job Details by ID", "description":"Get details of a given job.", "tags":[ "Job" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The job details were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Job" } } } } }, "x-internal-id":"job-{id}-get", "x-filename-id":"job-id-get" }, "delete":{ "summary":"Delete Job by ID", "description":"Delete the given Job.", "tags":[ "Job" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The job details were deleted successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string" }, "count":{ "type":"integer" } } } } } }, "404":{ "description":"Job details not found.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string" }, "error":{ "type":"string" }, "message":{ "type":"string" } } } } } } }, "x-internal-id":"job-{id}-delete", "x-filename-id":"job-id-delete" }, "patch":{ "summary":"Get Job Patch Details", "description":"Retrieve the patch details for a given job.", "tags":[ "Job" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobRequest" } } } }, "responses":{ "201":{ "description":"The job details were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JobResponse" } } } } }, "x-internal-id":"job-{id}-patch", "x-filename-id":"job-id-patch" } }, "/runtime/scenario":{ "post":{ "summary":"Create a Scenario", "description":"Creates a scenario.", "tags":[ "Scenario" ], "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioRequest" } } } }, "responses":{ "201":{ "description":"The scenario was created successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "_id":{ "type":"string" } } } } } } }, "x-internal-id":"runtime-scenario-post", "x-filename-id":"runtime-scenario-post" }, "get":{ "summary":"Get Scenario List", "description":"Get list of scenarios.", "tags":[ "Scenario" ], "responses":{ "200":{ "description":"The list of scenarios was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Scenarios" } } } } }, "x-internal-id":"runtime-scenario-get", "x-filename-id":"runtime-scenario-get" } }, "/runtime/scenario/{id}":{ "get":{ "summary":"Get Scenario by ID", "description":"Retrieves scenario based on ID.", "tags":[ "Scenario" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The scenario was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ScenarioResponse" } } } } }, "x-internal-id":"runtime-scenario-{id}-get", "x-filename-id":"runtime-scenario-id-get" }, "delete":{ "summary":"Delete Scenario by ID", "description":"Deletes the given scenario.", "tags":[ "Scenario" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The scenario was deleted successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string" }, "count":{ "type":"integer" } } } } } } }, "x-internal-id":"runtime-scenario-{id}-delete", "x-filename-id":"runtime-scenario-id-delete" } }, "/user":{ "get":{ "summary":"Get User List", "description":"Retrieves a list of users.", "tags":[ "User" ], "responses":{ "200":{ "description":"The list of users was retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Users" } } } } }, "x-internal-id":"user-get", "x-filename-id":"user-get" }, "post":{ "summary":"Create a User", "description":"Creates a user.", "tags":[ "User" ], "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UserCreate" } } } }, "responses":{ "201":{ "description":"The user was created successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "type":"string" } } } } } } }, "x-internal-id":"user-post", "x-filename-id":"user-post" } }, "/user/{id}":{ "get":{ "summary":"Get User Details by ID", "description":"Retrieves details of a given user.", "tags":[ "User" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The user details were retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/User" } } } } }, "x-internal-id":"user-{id}-get", "x-filename-id":"user-id-get" }, "delete":{ "summary":"Delete a User", "description":"Deletes the given user.", "tags":[ "User" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "responses":{ "200":{ "description":"The user details were deleted successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string" }, "count":{ "type":"integer" } } } } } } }, "x-internal-id":"user-{id}-delete", "x-filename-id":"user-id-delete" } }, "/user/changePassword/{id}":{ "patch":{ "summary":"Change Password by ID", "description":"Changes the password for the given user.", "tags":[ "User" ], "parameters":[ { "$ref":"#/components/parameters/Id" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "oldPassword":{ "type":"string" }, "newPassword":{ "type":"string" } } } } } }, "responses":{ "200":{ "description":"The password was changed successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"SUCCESS" } } } } } } }, "x-internal-id":"user-changePassword-{id}-patch", "x-filename-id":"user-changepassword-id-patch" } }, "/execution":{ "get":{ "summary":"Get Executions", "description":"Retrieves all executions.", "parameters":[ ], "operationId":"getAllExecutions", "responses":{ "default":{ "description":"The default response." } }, "tags":[ "Execution" ], "x-internal-id":"execution-get", "x-filename-id":"execution-get" }, "post":{ "summary":"Create an Execution", "description":"Creates an execution.", "parameters":[ ], "operationId":"createExecution", "responses":{ "default":{ "description":"The default response." } }, "tags":[ "Execution" ], "x-internal-id":"execution-post", "x-filename-id":"execution-post" } }, "/execution/{id}":{ "get":{ "summary":"Get Execution by ID", "description":"Retrieves the specified execution.", "parameters":[ { "$ref":"#/components/parameters/Id" } ], "operationId":"getExecutionById", "responses":{ "default":{ "description":"The default response." } }, "tags":[ "Execution" ], "x-internal-id":"execution-{id}-get", "x-filename-id":"execution-id-get" }, "patch":{ "summary":"Patch an Execution by ID", "description":"Partially updates the specified execution.", "parameters":[ { "$ref":"#/components/parameters/Id" } ], "operationId":"patchExecutionById", "responses":{ "default":{ "description":"The default response." } }, "tags":[ "Execution" ], "x-internal-id":"execution-{id}-patch", "x-filename-id":"execution-id-patch" }, "delete":{ "summary":"Delete an Execution by ID", "description":"Deletes the specified execution.", "parameters":[ { "$ref":"#/components/parameters/Id" } ], "operationId":"delteExecutionById", "responses":{ "default":{ "description":"The default response." } }, "tags":[ "Execution" ], "x-internal-id":"execution-{id}-delete", "x-filename-id":"execution-id-delete" } }, "/autotag/run":{ "post":{ "summary":"Run the AutoTagging process", "tags":[ "autotag" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "data":{ "type":"array", "items":{ "type":"object" } } } } } } }, "responses":{ "200":{ "description":"AutoTagging was completed successfully.", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"string", "example":"SUCCESS" }, "count":{ "type":"integer" } } } } } }, "400":{ "description":"Invalid request", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"integer", "example":400 }, "error":{ "type":"string" }, "message":{ "type":"string" } } } } } } }, "x-internal-id":"autotag-run-post", "x-filename-id":"autotag-run-post" } }, "/search/smartsearch":{ "post":{ "summary":"Perform SmartSearch with filters", "tags":[ "SmartSearch" ], "parameters":[ { "name":"page", "in":"query", "description":"Page number", "required":false, "schema":{ "type":"integer", "example":1 } }, { "name":"limit", "in":"query", "description":"Number of results per page", "required":false, "schema":{ "type":"integer", "example":10 } }, { "name":"sortDesc", "in":"query", "description":"Sort descending if true", "required":false, "schema":{ "type":"boolean", "example":true } } ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "query":{ "type":"string", "description":"Text to search", "example":"Account" }, "libraryType":{ "type":"string", "description":"Library type to search in", "example":"STEP" }, "useSemantic":{ "type":"boolean", "description":"Whether to use semantic search", "example":false } } } } } }, "responses":{ "200":{ "description":"SmartSearch results", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "total":{ "type":"integer", "example":15 }, "results":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" } } } } } } } } }, "400":{ "description":"Invalid request", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "status":{ "type":"integer", "example":400 }, "error":{ "type":"string" }, "message":{ "type":"string" } } } } } } }, "x-internal-id":"search-smartsearch-post", "x-filename-id":"search-smartsearch-post" } } }, "components":{ "schemas":{ "UserCreate":{ "type":"object", "properties":{ "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "middleName":{ "type":"string" }, "email":{ "type":"string" }, "isAdmin":{ "type":"integer" }, "username":{ "type":"string" }, "displayName":{ "type":"string" } } }, "User":{ "type":"object", "properties":{ "_id":{ "type":"integer" }, "email":{ "type":"string" }, "isAdmin":{ "type":"string" }, "lastName":{ "type":"string" }, "username":{ "type":"string" }, "firstName":{ "type":"string" }, "middleName":{ "type":"string" }, "profilePic":{ "type":"string" }, "displayName":{ "type":"string" } } }, "Users":{ "type":"object", "properties":{ "total":{ "type":"integer" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "page":{ "type":"integer" }, "pages":{ "type":"integer" }, "docs":{ "type":"array", "items":{ "$ref":"#/components/schemas/User" } } } }, "ActionListResponse":{ "type":"object", "properties":{ "total":{ "type":"integer", "example":17 }, "limit":{ "type":"integer", "example":10 }, "offset":{ "type":"integer", "example":0 }, "page":{ "type":"integer", "example":1 }, "pages":{ "type":"integer", "example":2 }, "docs":{ "type":"array", "items":{ "$ref":"#/components/schemas/Action" } } } }, "ActionLibraryResponse":{ "type":"array", "items":{ "$ref":"#/components/schemas/ActionLibraryItem" } }, "ActionLibraryItem":{ "type":"object", "properties":{ "bdd":{ "type":"string", "example":"read subscription" }, "data":{ "$ref":"#/components/schemas/ActionData" } } }, "Action":{ "type":"object", "properties":{ "_id":{ "type":"integer", "example":1 }, "bdd":{ "type":"string", "example":"read subscription" }, "data":{ "$ref":"#/components/schemas/ActionData" }, "name":{ "type":"string", "example":"Read Subscription" }, "path":{ "type":"string", "example":"/samples/subscription/read-subscription" }, "tags":{ "type":"array", "items":{ "type":"string" } }, "product":{ "type":"string", "example":"billing" }, "actionType":{ "type":"string", "example":"REST" }, "description":{ "type":"string", "example":"Read subscription from the billing system" } } }, "ActionData":{ "type":"object", "properties":{ "method":{ "type":"string", "example":"GET" }, "resource":{ "type":"string", "example":"subscription" }, "expectedStatusCode":{ "type":"string", "example":"200" } } }, "ActionProductResponse":{ "type":"array", "items":{ "type":"string" } }, "ActionCreate":{ "type":"object", "properties":{ "tags":{ "type":"array", "items":{ "type":"string" } }, "name":{ "type":"string", "example":"" }, "description":{ "type":"string" }, "bdd":{ "type":"string" }, "product":{ "type":"string" }, "actionType":{ "type":"string" }, "subType":{ "type":"string" }, "path":{ "type":"string" }, "request":{ "type":"string" }, "requestType":{ "type":"string" }, "expectedStatusCode":{ "type":"integer" }, "requestString":{ "type":"string" }, "resource":{ "type":"string" }, "method":{ "type":"string" }, "queryParameters":{ "type":"string" } } }, "ActionProductIdResponse":{ "type":"object", "properties":{ "actions":{ "type":"array", "items":{ "type":"object", "properties":{ "bdd":{ "type":"string" }, "data":{ "type":"object", "properties":{ "subType":{ "type":"string" }, "expectedStatusCode":{ "type":"string" } }, "required":[ "expectedStatusCode", "subType" ] }, "name":{ "type":"string" }, "path":{ "type":"string" }, "tags":{ "type":"array", "items":{ "type":"string" } }, "product":{ "type":"string" }, "actionType":{ "type":"string" }, "description":{ "type":"string" } } } }, "product":{ "type":"string" } } }, "ActionBDDResponse":{ "type":"object", "properties":{ "_id":{ "type":"integer" }, "bdd":{ "type":"string" }, "data":{ "type":"object", "properties":{ "topic":{ "type":"string" }, "commit":{ "type":"string" }, "subType":{ "type":"string" } }, "required":[ "commit", "subType", "topic" ] }, "name":{ "type":"string" }, "path":{ "type":"string" }, "tags":{ "type":"array", "items":{ "type":"string" } }, "product":{ "type":"string" }, "actionType":{ "type":"string" }, "description":{ "type":"string" } } }, "Environment":{ "type":"object", "properties":{ "_id":{ "type":"integer" }, "name":{ "type":"string" }, "build":{ "type":"string" }, "count":{ "type":"integer" }, "release":{ "type":"string" }, "connections":{ "type":"array", "items":{ "type":"integer" } }, "description":{ "type":"string" } } }, "Environments":{ "type":"object", "properties":{ "total":{ "type":"integer" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "page":{ "type":"integer" }, "pages":{ "type":"integer" }, "docs":{ "type":"array", "items":{ "$ref":"#/components/schemas/Environment" } } } }, "ExpandedEnv":{ "type":"object", "properties":{ "_id":{ "type":"integer" }, "name":{ "type":"string" }, "build":{ "type":"string" }, "count":{ "type":"integer" }, "release":{ "type":"string" }, "connections":{ "type":"array", "items":{ "type":"object", "properties":{ "_id":{ "type":"integer" }, "name":{ "type":"string" }, "type":{ "type":"string" }, "product":{ "type":"string" }, "properties":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" } }, "required":[ "name", "value" ] } }, "description":{ "type":"string" } }, "required":[ "_id", "description", "name", "product", "properties", "type" ] } }, "description":{ "type":"string" } } }, "JobRequest":{ "type":"object", "properties":{ "tag":{ "type":"array", "items":{ "type":"string" } }, "scenarioCount":{ "type":"integer" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "type":{ "type":"string" }, "environment_id":{ "type":"integer" }, "executionConfig":{ "type":"object", "properties":{ "group":{ "type":"array", "items":{ "type":"object", "properties":{ "scenarios":{ "type":"array", "items":{ "type":"integer" } }, "group":{ "type":"array", "items":{ "type":"string" } }, "name":{ "type":"string" }, "execution":{ "type":"string" } }, "required":[ "Execution", "group", "name", "Scenarios" ] } }, "name":{ "type":"string" }, "execution":{ "type":"string" } } } } }, "JobResponse":{ "type":"object", "properties":{ "_id":{ "type":"integer" }, "tag":{ "type":"array", "items":{ "type":"string" } }, "name":{ "type":"string" }, "type":{ "type":"string" }, "description":{ "type":"string" }, "scenarioCount":{ "type":"integer" }, "environment_id":{ "type":"integer" }, "executionConfig":{ "type":"object", "properties":{ "name":{ "type":"string" }, "group":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "group":{ "type":"array", "items":{ "type":"string" } }, "execution":{ "type":"string" }, "scenarios":{ "type":"array", "items":{ "type":"integer" } } } } }, "execution":{ "type":"string" } } } } }, "Job":{ "type":"object", "properties":{ "_id":{ "type":"integer" }, "name":{ "type":"string" }, "type":{ "type":"string" }, "description":{ "type":"string" }, "scenarioCount":{ "type":"string" }, "environment_id":{ "type":"integer" }, "environment_name":{ "type":"string" } } }, "Jobs":{ "type":"object", "properties":{ "total":{ "type":"integer" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "page":{ "type":"integer" }, "pages":{ "type":"integer" }, "docs":{ "type":"array", "items":{ "$ref":"#/components/schemas/Job" } } } }, "ScenarioRequest":{ "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "type":{ "type":"string" }, "namespace":{ "type":"string" }, "tags":{ "type":"string" }, "id":{ "type":"string" }, "mode":{ "type":"string" }, "priority":{ "type":"integer" }, "location":{ "type":"string" }, "testScenarioResult":{ "type":"string" }, "loadedFromConfig":{ "type":"boolean" }, "cases":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "type":{ "type":"string" }, "namespace":{ "type":"string" }, "tags":{ "type":"string" }, "id":{ "type":"string" }, "mode":{ "type":"string" }, "priority":{ "type":"integer" }, "hasChildren":{ "type":"boolean" }, "parent":{ "type":"string" }, "persona":{ "type":"string" }, "location":{ "type":"string" }, "hasCondition":{ "type":"boolean" }, "conditions":{ "type":"string" }, "testCaseResult":{ "type":"string" }, "child":{ "type":"boolean" }, "steps":{ "type":"array", "items":{ "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "type":{ "type":"string" }, "namespace":{ "type":"string" }, "tags":{ "type":"string" }, "id":{ "type":"string" }, "action":{ "type":"object", "properties":{ "path":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "tags":{ "type":"array", "items":{ "type":"string" } }, "bdd":{ "type":"string" }, "product":{ "type":"string" }, "actionType":{ "type":"string" }, "location":{ "type":"string" }, "resource":{ "type":"string" }, "method":{ "type":"string" } } } } } } } } } } }, "ScenarioResponse":{ "type":"object", "properties":{ "id":{ "type":"string" }, "_id":{ "type":"integer" }, "mode":{ "type":"string" }, "name":{ "type":"string" }, "tags":{ "type":"string" }, "type":{ "type":"string" }, "cases":{ "type":"array", "items":{ "type":"integer" } }, "location":{ "type":"string" }, "priority":{ "type":"string" }, "namespace":{ "type":"string" }, "description":{ "type":"string" }, "requestData":{ "type":"string" }, "loadedFromConfig":{ "type":"string" }, "testScenarioResult":{ "type":"string" } } }, "Scenarios":{ "properties":{ "total":{ "type":"integer" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "page":{ "type":"integer" }, "pages":{ "type":"integer" }, "docs":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScenarioResponse" } } } } }, "parameters":{ "Id":{ "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path" }, "productId":{ "name":"productId", "required":true, "schema":{ "type":"string" }, "in":"path" }, "bdd":{ "name":"bdd", "required":true, "schema":{ "type":"string" }, "in":"path" } } }, "swagger":"2.0", "tags":[ { "name":"Action", "description":"The operations from the Action category." }, { "name":"Environment", "description":"The operations from the Environment category." }, { "name":"Execution", "description":"The operations from the Execution category." }, { "name":"Job", "description":"The operations from the Job category." }, { "name":"Scenario", "description":"The operations from the Scenario category." }, { "name":"SmartSearch", "description":"The operations from the SmartSearch category." }, { "name":"User", "description":"The operations from the User category." }, { "name":"autotag", "description":"The operations from the autotag category." } ] }