# README
// Package model - Readme defines the struct and handles marshaling/unmarshaling the struct to/from NFT Storage. package model
// Readme defines a readme markdown file
type Readme struct {
Key string json:"_key,omitempty"
ObjType string json:"objtype,omitempty"
Content []string json:"content"
}
// NewReadme is the contructor that sets the appropriate default values func NewReadme() *Readme { return &Readme{ObjType: "Readme"} }
# Functions
NewApplications is the contructor that sets the appropriate default values.
NewApplicationVersion is the contructor that sets the appropriate default values.
NewApplicationVersionDetails is the contructor that sets the appropriate default values.
NewAuditLog is the contructor that sets the appropriate default values.
NewAuditRecord is the contructor that sets the appropriate default values.
NewCompAttrs is the constructor that sets the appropriate default values.
NewComponents is the contructor that sets the appropriate default values.
NewComponentVersion is the contructor that sets the appropriate default values.
NewComponentVersionDetails is the contructor that sets the appropriate default values.
NewDeployment is the contructor that sets the appropriate default values.
NewDeploymentDetails is the contructor that sets the appropriate default values.
NewDomain is the contructor that sets the appropriate default values.
NewEnvironment is the contructor that sets the appropriate default values.
NewGroup is the contructor that sets the appropriate default values.
NewGroupsForUser is the contructor that sets the appropriate default values.
NewLicense is the contructor that sets the appropriate default values.
NewPackage is the contructor that sets the appropriate default values.
NewPackageCVE is the contructor that sets the appropriate default values.
NewPackageLicense is the contructor that sets the appropriate default values.
NewPackages is the constructor that returns an empty array of Package instances.
NewProvenance is the contructor that sets the appropriate default values.
NewReadme is the contructor that sets the appropriate default values.
NewSBOM is the contructor that sets the appropriate default values.
NewScorecard is the contructor that sets the appropriate default values.
NewSwagger is the contructor that sets the appropriate default values.
NewUser is the contructor that sets the appropriate default values.
NewUsersForGroup is the contructor that sets the appropriate default values.
# Structs
Applications defines a list of Application Versions.
ApplicationVersion defines a Version of an Application for a List View.
ApplicationVersionDetails defines a Version of an Application including fine grained details.
AuditLog defines a list of Audit Records.
AuditRecord defines a single audit event.
CompAttrs defines the well-known attributes for a Component.
Components defines a list of Component Versions.
ComponentVersion defines a Version of an Component for a List View.
ComponentVersionDetails defines a Version of a Component including fine grained details.
Deployment defines a deployment for a List View.
DeploymentDetails defines a deployment plus the associated log.
Domain defines a dotted domain hierarchy.
Environment defines a logical location that the deployment was perform against.
Group defines a group of users.
GroupsForUser defines a user to a group.
License defines a license file for a Component Version.
Package defines a SBOM package dependency (subset of the full sbom) This struct is a collapsed version of the data returned from CycloneDX json struct.
PackageCVE defines a SBOM package dependency with the corresponding license (subset of the full sbom).
PackageLicense defines a SBOM package dependency with the corresponding license (subset of the full sbom).
Provenance defines the Provenance of an component in JSON format.
Readme defines a readme markdown file.
ResponseKey defines a struct to hold the NFT key in a json response.
SBOM defines a CycloneDX SBOM in JSON format.
Scorecard defines a OSSF scorecard for a repo + commit.
Swagger defines an OpenAPI or Swagger file.
User defines a user.
UsersForGroup defines a list of user that belong to the group.