Jump to

• Request
• Response

Compare Rules Files and Revisions

get

/api/rule/Rules/readDiff

Compares the specified rules files or file revisions and creates a diff to show the differences.

Request

Query Parameters

• fromFile: string
  The path to the file to compare on the "from" side of the diff.

  Example:

  example/base/auto/base.rules

• fromRevision: string
  The file revision number to compare on the "from" side of the diff.

  Example:

  3

• toFile: string
  The path to the file to compare to on the "to" side of the diff.

  Example:

  example1/base/auto/base.rules

• toRevision: string
  The file revision number to compare to on the "to" side of diff.

  Example:

  3

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
  The diff comparing the rules files.
• message: string
  The response message.

  Example:
• success: boolean
  Whether the operation was a success (true) or failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":""
        },
        "data":{
            "description":"The diff comparing the rules files.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ruleRulesReadDiff"
            }
        }
    },
    "type":"object"
}

Nested Schema : data

Type: array

The diff comparing the rules files.

Show Source

• Array of: object ruleRulesReadDiff

{
    "description":"The diff comparing the rules files.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ruleRulesReadDiff"
    }
}

Nested Schema : ruleRulesReadDiff

Type: object

Show Source

• fromFile: string
  The content of the file

  Example: /n=head1 NAME/n/n Auto Discovery Post Discovery Rules/n
• toFile: string
  The content of the file

  Example: /n=head1 NAME/n/n Auto Discovery Post Discovery Rules/n

{
    "properties":{
        "fromFile":{
            "description":"The content of the file",
            "type":"string",
            "example":"/n=head1 NAME/n/n Auto Discovery Post Discovery Rules/n"
        },
        "toFile":{
            "description":"The content of the file",
            "type":"string",
            "example":"/n=head1 NAME/n/n Auto Discovery Post Discovery Rules/n"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top