Jump to

• Request
• Response

Update a test suite

patch

https://{your_site_interface}/opa-hub/api/12.2.35/tests/{test-suite-name}

This operation will update a test suite.

Request

Path Parameters

• test-suite-name(required): string
  The name of the test suite to be retrieved.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• deployments: array deployments
  An array of deployment names associated with this test suite. The deployments must be in the same workspace as the test suite.
• description: string
  The description of the test suite, sufficient to distinguish it from other test suites.
• projects: array projects
  An array of project names associated with this test suite. The projects must be in the same workspace as the test suite.
• workspace: string
  The workspace for this test suite and all of its testcases. Test suites may only be associated with deployments or projects within the same workspace.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The description of the test suite, sufficient to distinguish it from other test suites.",
            "nullable":true
        },
        "workspace":{
            "type":"string",
            "description":"The workspace for this test suite and all of its testcases. Test suites may only be associated with deployments or projects within the same workspace."
        },
        "deployments":{
            "type":"array",
            "description":"An array of deployment names associated with this test suite. The deployments must be in the same workspace as the test suite.",
            "items":{
                "type":"string"
            }
        },
        "projects":{
            "type":"array",
            "description":"An array of project names associated with this test suite. The projects must be in the same workspace as the test suite.",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : deployments

Type: array

An array of deployment names associated with this test suite. The deployments must be in the same workspace as the test suite.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of deployment names associated with this test suite. The deployments must be in the same workspace as the test suite.",
    "items":{
        "type":"string"
    }
}

Nested Schema : projects

Type: array

An array of project names associated with this test suite. The projects must be in the same workspace as the test suite.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of project names associated with this test suite. The projects must be in the same workspace as the test suite.",
    "items":{
        "type":"string"
    }
}

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : testSuite

Type: object

Show Source

• deployments: array deployments
  An array of deployment names associated with this test suite. The deployments must be in the same workspace as the test suite.
• description: string
  The description of the test suite, sufficient to distinguish it from other test suites.
• name(required): string
  The name of the test suite.
• projects: array projects
  An array of project names associated with this test suite. The projects must be in the same workspace as the test suite.
• runs: object testRuns
• tagSummary: object testSuiteTagSummary
  Additional Properties Allowed: true
• testcases: object testCases
• testSummary: object testSuiteTestSummary
• testType(required): string
  Allowed Values: [ "batchAssess", "decisionService" ]

  The type of tests contained by this test suite. One of "batchAssess" or "decisionService".
• workspace: string
  The workspace for this test suite and all of its testcases. Test suites may only be associated with deployments or projects within the same workspace.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the test suite."
        },
        "description":{
            "type":"string",
            "description":"The description of the test suite, sufficient to distinguish it from other test suites.",
            "nullable":true
        },
        "workspace":{
            "type":"string",
            "description":"The workspace for this test suite and all of its testcases. Test suites may only be associated with deployments or projects within the same workspace."
        },
        "testType":{
            "type":"string",
            "description":"The type of tests contained by this test suite. One of \"batchAssess\" or \"decisionService\".",
            "enum":[
                "batchAssess",
                "decisionService"
            ]
        },
        "testSummary":{
            "description":"A summary of tests in the test suite.",
            "readOnly":true,
            "$ref":"#/components/schemas/testSuiteTestSummary"
        },
        "tagSummary":{
            "description":"A summary of all the tags declared by the contained test cases. The property names are tag names, and the values are the number of occurrences.",
            "readOnly":true,
            "$ref":"#/components/schemas/testSuiteTagSummary"
        },
        "deployments":{
            "type":"array",
            "description":"An array of deployment names associated with this test suite. The deployments must be in the same workspace as the test suite.",
            "items":{
                "type":"string"
            }
        },
        "projects":{
            "type":"array",
            "description":"An array of project names associated with this test suite. The projects must be in the same workspace as the test suite.",
            "items":{
                "type":"string"
            }
        },
        "testcases":{
            "$ref":"#/components/schemas/testCases"
        },
        "runs":{
            "$ref":"#/components/schemas/testRuns"
        }
    },
    "additionalProperties":false,
    "required":[
        "name",
        "testType"
    ]
}

Nested Schema : deployments

Type: array

An array of deployment names associated with this test suite. The deployments must be in the same workspace as the test suite.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of deployment names associated with this test suite. The deployments must be in the same workspace as the test suite.",
    "items":{
        "type":"string"
    }
}

Nested Schema : projects

Type: array

An array of project names associated with this test suite. The projects must be in the same workspace as the test suite.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of project names associated with this test suite. The projects must be in the same workspace as the test suite.",
    "items":{
        "type":"string"
    }
}

Nested Schema : testRuns

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testRun"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testSuiteTagSummary

Type: object

Additional Properties Allowed: true

Nested Schema : testCases

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testCase"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testSuiteTestSummary

Type: object

Show Source

• testsActive: number (double)
  Read Only: true

  The number of tests that are marked as active in the test suite.
• testsTotal: number (double)
  Read Only: true

  The total number of tests in the test suite.

{
    "type":"object",
    "properties":{
        "testsTotal":{
            "type":"number",
            "format":"double",
            "description":"The total number of tests in the test suite.",
            "readOnly":true
        },
        "testsActive":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that are marked as active in the test suite.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testRun

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testRun"
    }
}

Nested Schema : testRun

Type: object

Show Source

• deployments: object testRunDeployments
• projects: object testRunProjects
• runNumber: number (double)
  Read Only: true

  The identity number of the test run.
• status: string
  The status of this test run.
• summary: object testRunSummary
• type: string
  The type of this test run.

{
    "type":"object",
    "properties":{
        "runNumber":{
            "type":"number",
            "format":"double",
            "description":"The identity number of the test run.",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of this test run."
        },
        "status":{
            "type":"string",
            "description":"The status of this test run."
        },
        "deployments":{
            "$ref":"#/components/schemas/testRunDeployments"
        },
        "projects":{
            "$ref":"#/components/schemas/testRunProjects"
        },
        "summary":{
            "description":"The results summary of the test run.",
            "readOnly":true,
            "$ref":"#/components/schemas/testRunSummary"
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunDeployments

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testRunDeployment"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunProjects

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testRunProject"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunSummary

Type: object

Show Source

• error: number (double)
  The number of tests that encountered and error for the test run.
• failed: number (double)
  The number of tests that have failed for the test run.
• passed: number (double)
  The number of tests that have passed for the test run.
• pending: number (double)
  The number of tests that are pending for the test run.
• total: number (double)
  The total number of tests for the test run.

{
    "type":"object",
    "properties":{
        "total":{
            "type":"number",
            "format":"double",
            "description":"The total number of tests for the test run."
        },
        "passed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have passed for the test run."
        },
        "failed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have failed for the test run."
        },
        "error":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that encountered and error for the test run."
        },
        "pending":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that are pending for the test run."
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testRunDeployment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testRunDeployment"
    }
}

Nested Schema : testRunDeployment

Type: object

Show Source

• name: string
  Read Only: true

  The name of the tested deployment.
• results: object testRunDeploymentResults
• summary: object testRunDeploymentSummary
• version: number (double)
  Read Only: true

  The version of the tested deployment.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the tested deployment.",
            "readOnly":true
        },
        "version":{
            "type":"number",
            "format":"double",
            "description":"The version of the tested deployment.",
            "readOnly":true
        },
        "results":{
            "$ref":"#/components/schemas/testRunDeploymentResults"
        },
        "summary":{
            "description":"The results summary of the tested deployment.",
            "readOnly":true,
            "$ref":"#/components/schemas/testRunDeploymentSummary"
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunDeploymentResults

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testCaseResult"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunDeploymentSummary

Type: object

Show Source

• error: number (double)
  The number of tests that encountered and error for the tested deployment.
• failed: number (double)
  The number of tests that have failed for the tested deployment.
• passed: number (double)
  The number of tests that have passed for the tested deployment.
• pending: number (double)
  The number of tests that are pending for the tested deployment.
• total: number (double)
  The total number of tests for the tested deployment.

{
    "type":"object",
    "properties":{
        "total":{
            "type":"number",
            "format":"double",
            "description":"The total number of tests for the tested deployment."
        },
        "passed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have passed for the tested deployment."
        },
        "failed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have failed for the tested deployment."
        },
        "error":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that encountered and error for the tested deployment."
        },
        "pending":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that are pending for the tested deployment."
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testCaseResult

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testCaseResult"
    }
}

Nested Schema : testCaseResult

Type: object

Show Source

• actualOutput: object testCaseResultActualOutput
  Additional Properties Allowed: true
• expectedOutput: object testCaseResultExpectedOutput
  Additional Properties Allowed: true
• input: object testCaseResultInput
  Additional Properties Allowed: true
• name: string
  Read Only: true

  The name of the test case result.
• outcome: object testCaseResultOutcome
  Additional Properties Allowed: true
• status: string
  Read Only: true

  The status of the test case result.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the test case result.",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "description":"The status of the test case result.",
            "readOnly":true
        },
        "input":{
            "description":"The input data of the test case result.",
            "readOnly":true,
            "$ref":"#/components/schemas/testCaseResultInput"
        },
        "expectedOutput":{
            "description":"The expected output data of the test case result.",
            "readOnly":true,
            "$ref":"#/components/schemas/testCaseResultExpectedOutput"
        },
        "actualOutput":{
            "description":"The actual output data of the test case result.",
            "readOnly":true,
            "$ref":"#/components/schemas/testCaseResultActualOutput"
        },
        "outcome":{
            "description":"The outcome of the test case result.",
            "readOnly":true,
            "$ref":"#/components/schemas/testCaseResultOutcome"
        }
    },
    "additionalProperties":false
}

Nested Schema : testCaseResultActualOutput

Type: object

Additional Properties Allowed: true

Nested Schema : testCaseResultExpectedOutput

Type: object

Additional Properties Allowed: true

Nested Schema : testCaseResultInput

Type: object

Additional Properties Allowed: true

Nested Schema : testCaseResultOutcome

Type: object

Additional Properties Allowed: true

Nested Schema : items

Type: array

Show Source

• Array of: object testRunProject

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testRunProject"
    }
}

Nested Schema : testRunProject

Type: object

Show Source

• name: string
  Read Only: true

  The name of the tested project.
• results: object testRunProjectResults
• summary: object testRunProjectSummary
• version: number (double)
  Read Only: true

  The version of the tested project.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the tested project.",
            "readOnly":true
        },
        "version":{
            "type":"number",
            "format":"double",
            "description":"The version of the tested project.",
            "readOnly":true
        },
        "results":{
            "$ref":"#/components/schemas/testRunProjectResults"
        },
        "summary":{
            "description":"The results summary of the tested project.",
            "readOnly":true,
            "$ref":"#/components/schemas/testRunProjectSummary"
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunProjectResults

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/testCaseResult"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : testRunProjectSummary

Type: object

Show Source

• error: number (double)
  The number of tests that encountered and error for the tested project.
• failed: number (double)
  The number of tests that have failed for the tested project.
• passed: number (double)
  The number of tests that have passed for the tested project.
• pending: number (double)
  The number of tests that are pending for the tested project.
• total: number (double)
  The total number of tests for the tested project.

{
    "type":"object",
    "properties":{
        "total":{
            "type":"number",
            "format":"double",
            "description":"The total number of tests for the tested project."
        },
        "passed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have passed for the tested project."
        },
        "failed":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that have failed for the tested project."
        },
        "error":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that encountered and error for the tested project."
        },
        "pending":{
            "type":"number",
            "format":"double",
            "description":"The number of tests that are pending for the tested project."
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object testCaseResult

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testCaseResult"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object testCase

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/testCase"
    }
}

Nested Schema : testCase

Type: object

Show Source

• description: string
  The description of the test case, sufficient to distinguish it from other test cases in this test suite.
• enabled: boolean
  Default Value: true

  Determines whether the test case has been activated within the test case with which it is associated.
• expectedOutput: object testCaseExpectedOutput
  Additional Properties Allowed: true
• input: object testCaseInput
  Additional Properties Allowed: true
• name(required): string
  The name of the test case, unique to the test suite.
• tags(required): array tags
  A set of all the tags declared by this test case.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the test case, unique to the test suite."
        },
        "description":{
            "type":"string",
            "description":"The description of the test case, sufficient to distinguish it from other test cases in this test suite.",
            "nullable":true
        },
        "enabled":{
            "type":"boolean",
            "description":"Determines whether the test case has been activated within the test case with which it is associated.",
            "default":true
        },
        "tags":{
            "type":"array",
            "description":"A set of all the tags declared by this test case.",
            "items":{
                "type":"string"
            }
        },
        "expectedOutput":{
            "description":"An expected output for the test case.",
            "$ref":"#/components/schemas/testCaseExpectedOutput"
        },
        "input":{
            "description":"The input for the test case.",
            "$ref":"#/components/schemas/testCaseInput"
        }
    },
    "additionalProperties":false,
    "required":[
        "name",
        "tags"
    ]
}

Nested Schema : testCaseExpectedOutput

Type: object

Additional Properties Allowed: true

Nested Schema : testCaseInput

Type: object

Additional Properties Allowed: true

Nested Schema : tags

Type: array

A set of all the tags declared by this test case.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A set of all the tags declared by this test case.",
    "items":{
        "type":"string"
    }
}

Back to Top