dependency_submission

Creates, updates, deletes, gets or lists a dependency_submission resource.

Overview

Name	dependency_submission
Type	Resource
Id	github.dependency_graph.dependency_submission

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_repository_snapshot	insert	owner, repo, detector, version, ref, sha, job, scanned		Create a new snapshot of a repository's dependencies. The authenticated user must have access to the repository. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

INSERT examples

create_repository_snapshot

Create a new snapshot of a repository's dependencies.

The authenticated user must have access to the repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

INSERT INTO github.dependency_graph.dependency_submission (
version,
job,
sha,
ref,
detector,
metadata,
manifests,
scanned,
owner,
repo
)
SELECT 
{{ version }} /* required */,
'{{ job }}' /* required */,
'{{ sha }}' /* required */,
'{{ ref }}' /* required */,
'{{ detector }}' /* required */,
'{{ metadata }}',
'{{ manifests }}',
'{{ scanned }}' /* required */,
'{{ owner }}',
'{{ repo }}'
RETURNING
id,
created_at,
message,
result
;

Manifest

# Description fields are for documentation purposes
- name: dependency_submission
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the dependency_submission resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the dependency_submission resource.
  - name: version
    value: {{ version }}
    description: |
      The version of the repository snapshot submission.
  - name: job
    value:
      id: "{{ id }}"
      correlator: "{{ correlator }}"
      html_url: "{{ html_url }}"
  - name: sha
    value: "{{ sha }}"
    description: |
      The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
  - name: ref
    value: "{{ ref }}"
    description: |
      The repository branch that triggered this snapshot.
  - name: detector
    description: |
      A description of the detector used.
    value:
      name: "{{ name }}"
      version: "{{ version }}"
      url: "{{ url }}"
  - name: metadata
    value: "{{ metadata }}"
    description: |
      User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
  - name: manifests
    value: "{{ manifests }}"
    description: |
      A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.
  - name: scanned
    value: "{{ scanned }}"
    description: |
      The time at which the snapshot was scanned.