Jump to

• Request
• Response

Update a test case

patch

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

This operation will update a test case.

Request

Path Parameters

• test-case-name(required): string
  The name of the test case to be retrieved.
• 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

• 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 testCaseExpectedOutputPatch
  Additional Properties Allowed: true
• input: object testCaseInputPatch
  Additional Properties Allowed: true
• tags: array tags
  A set of all the tags declared by this test case.

{
    "type":"object",
    "properties":{
        "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/testCaseExpectedOutputPatch"
        },
        "input":{
            "description":"The input for the test case.",
            "$ref":"#/components/schemas/testCaseInputPatch"
        }
    },
    "additionalProperties":false
}

Nested Schema : testCaseExpectedOutputPatch

Type: object

Additional Properties Allowed: true

Nested Schema : testCaseInputPatch

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"
    }
}

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 : 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