Skip to content

feat: Update Data Shares dictionary and Export API docs on new target_file field #586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ Snyk Reports only presents monitored projects that were not deleted. To match yo
| `target_source_type` | varchar | The hosting provider of a given target, for example, docker-hub, github, and so on. |
| `target_source_type_display_value` | varchar | A display value that represents the grouping for target sources, for example, Source Control, Container Registry, and so on. |
| `target_upstream_url` | varchar | The URL pointing to a target's upstream source, such as a URL for a GitHub repository. |
| `target_file` | varchar | The full file path within a project that Snyk is targeting for security scanning, such as /var/www/composer.lock, /app/package.json, or other dependency manifest files. |
| `criticalities` | array | A project attribute that indicates business criticality. For example, low, medium, high, critical. |
| `lifecycles` | array | A project attribute, for example, production, development, sandbox. |
| `environments` | array | A project attribute, for example, frontend, backend, internal, external, mobile, saas, onprem, hosted, distributed. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ Use the exact filter value as it appears in the Snyk Web UI. To clarify this req
"PROJECT_TARGET_SOURCE_TYPE",
"PROJECT_TARGET_SOURCE_TYPE_DISPLAY_VALUE",
"PROJECT_TARGET_UPSTREAM_URL",
"PROJECT_TARGET_FILE",
"PROJECT_OWNER_EMAIL",
"ISSUE_DELETED_AT",
"PROJECT_DELETED_AT",
Expand Down Expand Up @@ -208,7 +209,7 @@ Use the exact filter value as it appears in the Snyk Web UI. To clarify this req

**Project and Target context**

<table><thead><tr><th width="318">Column name</th><th>Description</th></tr></thead><tbody><tr><td><code>project_public_id</code></td><td>A universally unique identifier for a Project, assigned in the source database or the record.</td></tr><tr><td><code>project_name</code></td><td>The name given to this Project, when added to Snyk.</td></tr><tr><td><code>project_url</code></td><td>The project URL in Snyk platform.</td></tr><tr><td><code>project_is_monitored</code></td><td>The Project is set to be actively monitored. By default, the API returns only monitored issues of the Project. To fetch issues of deactivated Projects, check the API parameters.</td></tr><tr><td><code>project_type</code></td><td>The scanning method to use for a particular Project, such as Static Application Security Testing (SAST) for scanning using Snyk Code, or Maven for a Maven Project using Snyk Open Source. This is part of the configuration for scanning.</td></tr><tr><td><code>project_type_display_name</code></td><td>A display name Snyk assigned to internal Project type values.</td></tr><tr><td><code>project_test_frequency</code></td><td>The frequency of testing for a given Project, for example, Daily, Weekly, and so on.</td></tr><tr><td><code>project_origin</code></td><td>The Origin defines the Target ecosystem, such as CLI, GitHub, or Kubernetes. Origins are a property of Targets.</td></tr><tr><td><code>project_target_ref</code></td><td>A reference that differentiates this Project, for example, a branch name or version. Projects having the same reference can be grouped based on that reference.</td></tr><tr><td><code>project_target_runtime</code></td><td>The environment in which the Target is executed and run.</td></tr><tr><td><code>project_target_display_name</code></td><td>A display name for the Project's Target.</td></tr><tr><td><code>project_is_private_target</code></td><td>Indicates whether the Target's source is private or publicly reachable</td></tr><tr><td><code>project_target_source_type</code></td><td>The hosting provider of a givenTarget, for example, <code>docker-hub</code>, <code>github</code>, and so on.</td></tr><tr><td><code>project_target_source_type_display_value</code></td><td>A display value that represents the grouping forTarget sources, for example, Source Control, Container Registry, and so on.</td></tr><tr><td><code>project_target_upstream_url</code></td><td>The URL that points to a Target's upstream source, such as a URL for a GitHub repository.</td></tr><tr><td><code>project_criticalities</code></td><td>A Project attribute that indicates business criticality. For example, <code>low</code>, <code>medium</code>, <code>high</code>, <code>critical</code>.</td></tr><tr><td><code>project_lifecycles</code></td><td>A Project attribute, for example, <code>production</code>, <code>development</code>, <code>sandbox</code>.</td></tr><tr><td><code>project_environments</code></td><td>A Poject attribute, for example, <code>frontend</code>, <code>backend</code>, <code>internal</code>, <code>external</code>, <code>mobile</code>, <code>saas</code>, <code>onprem</code>, <code>hosted</code>, <code>distributed</code>.</td></tr><tr><td><code>project_collections</code></td><td>All Project collections to which this Project has been added.</td></tr><tr><td><code>project_tags</code></td><td>All tags which have been assigned to this Project.</td></tr><tr><td><code>project_owner_email</code></td><td>The email of the user assigned as the owner of this Project.</td></tr><tr><td><code>project_owner_username</code></td><td>The username of the user assigned as the owner of this Project.</td></tr></tbody></table>
<table><thead><tr><th width="318">Column name</th><th>Description</th></tr></thead><tbody><tr><td><code>project_public_id</code></td><td>A universally unique identifier for a Project, assigned in the source database or the record.</td></tr><tr><td><code>project_name</code></td><td>The name given to this Project, when added to Snyk.</td></tr><tr><td><code>project_url</code></td><td>The project URL in Snyk platform.</td></tr><tr><td><code>project_is_monitored</code></td><td>The Project is set to be actively monitored. By default, the API returns only monitored issues of the Project. To fetch issues of deactivated Projects, check the API parameters.</td></tr><tr><td><code>project_type</code></td><td>The scanning method to use for a particular Project, such as Static Application Security Testing (SAST) for scanning using Snyk Code, or Maven for a Maven Project using Snyk Open Source. This is part of the configuration for scanning.</td></tr><tr><td><code>project_type_display_name</code></td><td>A display name Snyk assigned to internal Project type values.</td></tr><tr><td><code>project_test_frequency</code></td><td>The frequency of testing for a given Project, for example, Daily, Weekly, and so on.</td></tr><tr><td><code>project_origin</code></td><td>The Origin defines the Target ecosystem, such as CLI, GitHub, or Kubernetes. Origins are a property of Targets.</td></tr><tr><td><code>project_target_ref</code></td><td>A reference that differentiates this Project, for example, a branch name or version. Projects having the same reference can be grouped based on that reference.</td></tr><tr><td><code>project_target_runtime</code></td><td>The environment in which the Target is executed and run.</td></tr><tr><td><code>project_target_display_name</code></td><td>A display name for the Project's Target.</td></tr><tr><td><code>project_is_private_target</code></td><td>Indicates whether the Target's source is private or publicly reachable</td></tr><tr><td><code>project_target_source_type</code></td><td>The hosting provider of a givenTarget, for example, <code>docker-hub</code>, <code>github</code>, and so on.</td></tr><tr><td><code>project_target_source_type_display_value</code></td><td>A display value that represents the grouping forTarget sources, for example, Source Control, Container Registry, and so on.</td></tr><tr><td><code>project_target_upstream_url</code></td><td>The URL that points to a Target's upstream source, such as a URL for a GitHub repository.</td></tr><tr><td><code>project_target_file</code></td><td>The full file path within a project that Snyk is targeting for security scanning, such as /var/www/composer.lock, /app/package.json, or other dependency manifest files.</td></tr><tr><td><code>project_criticalities</code></td><td>A Project attribute that indicates business criticality. For example, <code>low</code>, <code>medium</code>, <code>high</code>, <code>critical</code>.</td></tr><tr><td><code>project_lifecycles</code></td><td>A Project attribute, for example, <code>production</code>, <code>development</code>, <code>sandbox</code>.</td></tr><tr><td><code>project_environments</code></td><td>A Poject attribute, for example, <code>frontend</code>, <code>backend</code>, <code>internal</code>, <code>external</code>, <code>mobile</code>, <code>saas</code>, <code>onprem</code>, <code>hosted</code>, <code>distributed</code>.</td></tr><tr><td><code>project_collections</code></td><td>All Project collections to which this Project has been added.</td></tr><tr><td><code>project_tags</code></td><td>All tags which have been assigned to this Project.</td></tr><tr><td><code>project_owner_email</code></td><td>The email of the user assigned as the owner of this Project.</td></tr><tr><td><code>project_owner_username</code></td><td>The username of the user assigned as the owner of this Project.</td></tr></tbody></table>

**Assets and application context**

Expand Down