code-scanning-analysis
objectThe full Git reference, formatted as refs/heads/<branch name>,
refs/pull/<number>/merge, or refs/pull/<number>/head.
The SHA of the commit to which the analysis you are uploading relates.
Match pattern:^[0-9a-fA-F]+$
>= 40 characters<= 40 characters
Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
Identifies the variable values associated with the environment in which this analysis was performed.
Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
Example:error reading field xyz
The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The total number of results in the analysis.
The total number of rules used in the analysis.
Unique identifier for this analysis.
The REST API URL of the analysis resource.
An identifier for the upload.
Example:6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
Show Child Parameters
Warning generated when processing the analysis
Example:123 results were ignored
code-scanning-analysis-sarif-file
stringA Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see “SARIF support for code scanning.”
code-scanning-sarifs-receipt
objectAn identifier for the upload.
Example:6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
The REST API URL for checking the status of the upload.
Collaborator
objectCollaborator
Example:octocat
Example:1
Example:MDQ6VXNlcjE=
Example:https://github.com/images/error/octocat_happy.gif
Example:41d064eb2195891e12d0413f63227ea7
Example:https://api.github.com/users/octocat
Example:https://github.com/octocat
Example:https://api.github.com/users/octocat/followers
Example:https://api.github.com/users/octocat/following{/other_user}
Example:https://api.github.com/users/octocat/gists{/gist_id}
Example:https://api.github.com/users/octocat/starred{/owner}{/repo}
Example:https://api.github.com/users/octocat/subscriptions
Example:https://api.github.com/users/octocat/orgs
Example:https://api.github.com/users/octocat/repos
Example:https://api.github.com/users/octocat/events{/privacy}
Example:https://api.github.com/users/octocat/received_events
Example:User
Show Child Parameters
Repository Invitation
objectRepository invitations let you manage who you collaborate with.
Unique identifier of the repository invitation.
Example:42
Minimal Repository
Show Child Parameters
Simple User
Show Child Parameters
Simple User
Show Child Parameters
The permission associated with the invitation.
Allowed values:readwriteadmintriagemaintain
Example:read
Example:2016-06-13T14:52:50-05:00
Whether or not the invitation has expired
URL for the repository invitation
Example:https://api.github.com/user/repository-invitations/1
Example:https://github.com/octocat/Hello-World/invitations