Description: Compares two artifacts and produces the difference between them
Security: Requires a valid user with the "Read" permission
Usage: POST /dependencyGraph/artifactDelta
Consumes: application/json
Artifactory ID
The artifactory_id parameter is no longer required in Xray version 3.x, this parameter (also within a path) will be ignored.
{ "source_artifact_path":"<artifactory/repo/path>", "target_artifact_path":"<artifactory/repo/path>" }
Produces:
{ "source_artifact":{ "name": "<The name of the source artifact we are comparing>", "path": "<artifactory-name/repo-name/path>", "pkg_type": "<Package type>", "sha256": "<Artifact's SHA256 checksum>", "sha1": "<Artifact's SHA1 checksum>", }, "target_artifact":{ "name": "<The name of the target artifact we are comparing>", "path": "<artifactory-name/repo-name/path>", "pkg_type": "<Package type>", "sha256": "<Artifact's SHA256 checksum>", "sha1": "<Artifact's SHA1 checksum>", }, "removed":[ { "component_name":"<Component name only found in source artifact>", "component_id":"<Dependency Component ID only found in source artifact>", "package_type":"<Dependency component package type>", "version":"<Dependency component version>", "created":"<ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)>", "modified":"<ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)>" } ], "added":[ { "component_name":"<Component name only found in target artifact>", "component_id":"<Dependency Component ID only found in target artifact>", "package_type":"<Dependency component package type>", "version":"<Dependency component version>", "created":"<ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)>", "modified":"<ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)>", } ], "unchanged":[ { "component_name":"<Component name only found in both artifacts>", "component_id":"<Dependency Component ID only found in both artifacts>", "package_type":"<Dependency component package type>", "version":"<Dependency component version>", "created":"<ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)>", "modified":"<ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)>", } ] }
Sample Usage:
POST /dependencyGraph/artifactDelta { "source_artifact_path":"/pnnl/goss/goss-core-client/0.1.7/goss-core-client-0.1.7-sources.jar", "target_artifact_path":"/pnnl/goss/goss-core-client/0.1.8/goss-core-client-0.1.8-sources.jar", } { "source_artifact":{ "name": "artifactory-pro.zip", "path": "art2/ext-release-local/", "pkg_type": "Generic", "sha256": "d160c68ed8879ae42756e159daec1dd7ecfd53b6192321656b72715e20d46dd2", "sha1": "" }, "target_artifact":{ "name": "artifactory-pro.zip", "path": "art2/ext-release-local/", "pkg_type": "Generic", "sha256": "d160c68ed8879ae42756e159daec1dd7ecfd53b6192321656b72715e20d46dd2", "sha1": "" }, "removed":[ { "component_name":"some-component-1.1", "component_id":"pip://some-component:1.1", "package_type":"pip", "version":"1.1", "created":"2008-06-09T16:50:19Z", "modified":"2015-07-26T17:49:47Z" } ], "added":[ { "component_name":"Jinja2.7.2", "component_id":"pip://Jinja2:2.7.2", "package_type":"pip", "version":"2.7.2", "created":"2008-06-09T16:50:19Z", "modified":"2015-07-26T17:49:47Z" } ], "unchanged":[ { "component_name":"Apache1.4", "component_id":"gav://apache:1.4", "package_type":"maven", "version":"1.4", "created":"2008-06-09T16:50:19Z", "modified":"2015-07-26T17:49:47Z" } ] }
Response Codes:200: Success
400: Artifact '<PATH>' doesn't exist or isn't indexed in Xray
401: Bad Credentials
415: Failed to parse request