The Coverity on Polaris API is comprised of the following services.
Auth V0
- Authenticates and authorizes users of all public (external) APIs on the Coverity on Polaris Platform. Authentication configurations can be managed with endpoints API tokens and SAML identity providers; authorization can be managed with entitlements and role-assignments.
- Manages organizations, groups, users, roles, licenses, and terms-of-use.
Auth V1
- Authenticates and authorizes users of all public (external) APIs on the Coverity on Polaris Platform. Authentication configurations can be managed with endpoints API tokens and SAML identity providers; authorization can be managed with entitlements and role-assignments.
- Manages organizations, groups, users, roles, licenses, and terms-of-use.
Auth V1 enhances the response models and fixes issues with respect to v0. Licenses endpoints have been updated in this release.
Common Objects Service
- Retrieves information about the tools available to an organization.
- Retrieves information about projects, branches, and revisions the user has permission to view.
- Retrieves the metadata from scans (runs) that the user has permission to view. Metadata includes such things as run, start, and complete times, and Coverity Checkers enabled for a run.
- Retrieves project properties and run properties.
Issue Query V0
- Aggregates issue data that has been uploaded to Coverity on Polaris.
- Provides a filtered list of issues or a count.
- Provides issue details.
V1 supersedes V0. New implementations should use V1.
Issue Query V1
- Aggregates issue data that has been uploaded to Coverity on Polaris.
- Provides a filtered list of issues or a count.
- Provides issue details.
V1 supersedes V0. New implementations should use V1.
Issue Type Service
Provides users with the ability to query the issue types that are known to Coverity on Polaris, filtering as necessary. Descriptive fields, such as the name and description of the issue type, are localized to the user's preferred language if a translation exists.
Jobs Service
- Creates and cancels jobs. A job is an attempt to run a supported tool through this service. A successful job gets a run id, which is associated with results that you can to manage in the UI or with the Issues Management and Triage APIs.
- Retrieves lists of jobs.
- Manages multi-part upload of large files required by jobs. Multi-part upload should be used for upload of larger files as it provides better error handling, mitigation, and recovery capabilities.
- Retrieves logs or files produced by completed jobs.
- Retrieves API documentation.
Coverity analysis is the principle tool, and other Black Duck tools will be added.
Notifications Service
Delivers notifications when an event occurs in Coverity on Polaris. Supported events include completed scan and failed job. Notification can be by email or webhook.
TDS Code Analysis Service
- Stores domain-specific information provided by Coverity Static Analysis, providing information not available through the Issue Manager.
- Provides source code snippets, event trees, function summaries, and other information.
Tools Service
- Provides tools, license files, and client applications for download.
- Retrieves information about supported analysis tools and client applications, including available versions.
New implementations should use V1. It provides information about recommended versions and deprecated versions, which isn't available on Tools Service V0.
Client tools include: Coverity, Coverity Capture Kit (captures artifacts for analysis), Coverity Uploader (used by Coverity on Polaris CLI to upload local analysis results), and Point and Scan.
Tools Service - v1
- Provides tools, license files, and client applications for download.
- Retrieves information about supported analysis tools and client applications, including available, recommended, and deprecated versions.
New implementations should use V1. It provides information about recommended versions and deprecated versions, which isn't available on Tools Service V0.
Client tools include: Coverity, Coverity Capture Kit (captures artifacts for analysis), Coverity Uploader (used by Coverity on Polaris CLI to upload local analysis results), and Point and Scan.
Triage Command Handler - V0
Sets the triage value of issues on Coverity on Polaris, so they can be read by Triage Query and other services. Triage information includes: the assigned owner of an issue, whether the issue is dismissed or not, and text comments.
Triage Command Handler - V1
Sets the triage value of issues on Coverity on Polaris, so they can be read by Triage Query and other services. Triage information includes: the assigned owner of an issue, whether the issue is dismissed, reason for dismissal (if dismissed), and text comments.
Triage Query - V0
- Retrieves the triage state of issues on Coverity on Polaris. Triage information includes: the assigned owner of an issue, whether the issue is dismissed and text comments.
- Retrieves triage history.
Triage Query - V1
- Retrieves the triage state of issues on Coverity on Polaris. Triage information includes: the assigned owner of an issue, whether the issue is dismissed, reason for dismissal (if dismissed), and text comments.
- Retrieves triage history.