# README
Go API client for Grafeas
This is a heavily modified and working fork of the generated Swagger go client, adapted to follow the OpenApi specification as recorded here. It also provides the client as a mockable interface and removes unnecessary complexity of the original.
This is a client library for the Grafeas API in Go, generated by Swagger Codegen.
Overview
- API version: v1beta1
- Package version: 0.1.0
- Build package: io.swagger.codegen.languages.GoClientCodegen
Installation
go get github.com/ocibuilder/gofeas
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| GrafeasV1Beta1Api | BatchCreateNotes | Post /v1beta1/{parent=projects/*}/notes:batchCreate | Creates new notes in batch. |
| GrafeasV1Beta1Api | BatchCreateOccurrences | Post /v1beta1/{parent=projects/*}/occurrences:batchCreate | Creates new occurrences in batch. |
| GrafeasV1Beta1Api | CreateNote | Post /v1beta1/{parent=projects/*}/notes | Creates a new note. |
| GrafeasV1Beta1Api | CreateOccurrence | Post /v1beta1/{parent=projects/*}/occurrences | Creates a new occurrence. |
| GrafeasV1Beta1Api | DeleteNote | Delete /v1beta1/{name=projects//notes/} | Deletes the specified note. |
| GrafeasV1Beta1Api | DeleteOccurrence | Delete /v1beta1/{name=projects//occurrences/} | Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource. |
| GrafeasV1Beta1Api | GetNote | Get /v1beta1/{name=projects//notes/} | Gets the specified note. |
| GrafeasV1Beta1Api | GetOccurrence | Get /v1beta1/{name=projects//occurrences/} | Gets the specified occurrence. |
| GrafeasV1Beta1Api | GetOccurrenceNote | Get /v1beta1/{name=projects//occurrences/}/notes | Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project. |
| GrafeasV1Beta1Api | GetVulnerabilityOccurrencesSummary | Get /v1beta1/{parent=projects/*}/occurrences:vulnerabilitySummary | Gets a summary of the number and severity of occurrences. |
| GrafeasV1Beta1Api | ListNoteOccurrences | Get /v1beta1/{name=projects//notes/}/occurrences | Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. |
| GrafeasV1Beta1Api | ListNotes | Get /v1beta1/{parent=projects/*}/notes | Lists notes for the specified project. |
| GrafeasV1Beta1Api | ListOccurrences | Get /v1beta1/{parent=projects/*}/occurrences | Lists occurrences for the specified project. |
| GrafeasV1Beta1Api | UpdateNote | Patch /v1beta1/{name=projects//notes/} | Updates the specified note. |
| GrafeasV1Beta1Api | UpdateOccurrence | Patch /v1beta1/{name=projects//occurrences/} | Updates the specified occurrence. |
Documentation For Models
- AliasContextKind
- AttestationAttestation
- AttestationAuthority
- AttestationGenericSignedAttestation
- AttestationGenericSignedAttestationContentType
- AttestationPgpSignedAttestation
- AttestationPgpSignedAttestationContentType
- AuthorityHint
- BuildBuild
- BuildBuildSignature
- BuildSignatureKeyType
- CvsSv3AttackComplexity
- CvsSv3AttackVector
- CvsSv3Impact
- CvsSv3PrivilegesRequired
- CvsSv3Scope
- CvsSv3UserInteraction
- DeploymentDeployable
- DeploymentDeployment
- DeploymentPlatform
- DiscoveredAnalysisStatus
- DiscoveredContinuousAnalysis
- DiscoveryDiscovered
- DiscoveryDiscovery
- HashHashType
- ImageBasis
- ImageDerived
- ImageFingerprint
- ImageLayer
- LayerDirective
- PackageArchitecture
- PackageDistribution
- PackageInstallation
- PackagePackage
- PackageVersion
- ProtobufAny
- ProtobufFieldMask
- ProvenanceArtifact
- ProvenanceBuildProvenance
- ProvenanceCommand
- ProvenanceFileHashes
- ProvenanceHash
- ProvenanceSource
- RpcStatus
- SourceAliasContext
- SourceCloudRepoSourceContext
- SourceGerritSourceContext
- SourceGitSourceContext
- SourceProjectRepoId
- SourceRepoId
- SourceSourceContext
- V1beta1BatchCreateNotesRequest
- V1beta1BatchCreateNotesResponse
- V1beta1BatchCreateOccurrencesRequest
- V1beta1BatchCreateOccurrencesResponse
- V1beta1ListNoteOccurrencesResponse
- V1beta1ListNotesResponse
- V1beta1ListOccurrencesResponse
- V1beta1Note
- V1beta1NoteKind
- V1beta1Occurrence
- V1beta1RelatedUrl
- V1beta1Resource
- V1beta1Signature
- V1beta1VulnerabilityOccurrencesSummary
- V1beta1attestationDetails
- V1beta1buildDetails
- V1beta1deploymentDetails
- V1beta1discoveryDetails
- V1beta1imageDetails
- V1beta1packageDetails
- V1beta1packageLocation
- V1beta1vulnerabilityDetails
- VersionVersionKind
- VulnerabilityCvsSv3
- VulnerabilityDetail
- VulnerabilityOccurrencesSummaryFixableTotalByDigest
- VulnerabilityPackageIssue
- VulnerabilitySeverity
- VulnerabilityVulnerability
- VulnerabilityVulnerabilityLocation
- VulnerabilityWindowsDetail
- WindowsDetailKnowledgeBase
Documentation For Authorization
Endpoints do not require authorization.
Author
Grafeas authors.