{ "components": { "schemas": { "compliance.PolicyEvaluation": { "properties": { "compliant": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "opaqueId": { "description": "only used by global policies maintained by the community and migrated by the system", "type": "string" }, "organization": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "organizationId": { "description": "will be null for global policies", "type": "string" }, "predicateType": { "type": "string" }, "projects": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Project" }, "type": "array", "uniqueItems": false }, "rawEvaluationResult": { "additionalProperties": {}, "type": "object" }, "rego": { "type": "string" }, "title": { "type": "string" }, "violations": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "compliant", "description", "id", "opaqueId", "organization", "organizationId", "predicateType", "projects", "rawEvaluationResult", "rego", "title", "violations" ], "type": "object" }, "controllers.ArtifactRequest": { "properties": { "artifactName": { "type": "string" }, "informationSources": { "items": { "$ref": "#/components/schemas/controllers.informationSource" }, "type": "array", "uniqueItems": false } }, "required": [ "artifactName", "informationSources" ], "type": "object" }, "controllers.ArtifactUpdateResponse": { "properties": { "artifact": { "$ref": "#/components/schemas/dtos.ArtifactDTO" }, "invalidURLs": { "items": { "$ref": "#/components/schemas/dtos.ExternalReferenceError" }, "type": "array", "uniqueItems": false } }, "required": [ "artifact", "invalidURLs" ], "type": "object" }, "controllers.LicenseRiskStatus": { "properties": { "justification": { "maxLength": 4000, "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "status": { "type": "string" } }, "required": [ "justification", "mechanicalJustification", "status" ], "type": "object" }, "controllers.PURLInspectResponse": { "properties": { "affectedComponents": { "items": { "$ref": "#/components/schemas/dtos.AffectedComponentDTO" }, "type": "array", "uniqueItems": false }, "component": { "$ref": "#/components/schemas/dtos.ComponentDTO" }, "maliciousPackage": { "$ref": "#/components/schemas/dtos.OSV" }, "matchContext": { "$ref": "#/components/schemas/normalize.PurlMatchContext" }, "purl": { "type": "string" }, "vulns": { "items": { "$ref": "#/components/schemas/dtos.VulnInPackageDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "affectedComponents", "component", "maliciousPackage", "matchContext", "purl", "vulns" ], "type": "object" }, "controllers.informationSource": { "properties": { "purl": { "type": "string" }, "type": { "description": "type can be \"csaf\", \"vex\", \"sbom\"", "type": "string" }, "url": { "type": "string" } }, "required": [ "purl", "type", "url" ], "type": "object" }, "controllers.licenseResponse": { "properties": { "count": { "type": "integer" }, "license": { "$ref": "#/components/schemas/licenses.License" } }, "required": [ "count", "license" ], "type": "object" }, "controllers.statementPayload": { "properties": { "description": { "type": "string" }, "implementationStatus": { "type": "string" } }, "required": [ "description", "implementationStatus" ], "type": "object" }, "cyclonedx.Advisory": { "properties": { "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "title", "url" ], "type": "object" }, "cyclonedx.AffectedVersions": { "properties": { "range": { "type": "string" }, "status": { "$ref": "#/components/schemas/cyclonedx.VulnerabilityStatus" }, "version": { "type": "string" } }, "required": [ "range", "status", "version" ], "type": "object" }, "cyclonedx.Affects": { "properties": { "ref": { "type": "string" }, "versions": { "items": { "$ref": "#/components/schemas/cyclonedx.AffectedVersions" }, "type": "array", "uniqueItems": false } }, "required": [ "ref", "versions" ], "type": "object" }, "cyclonedx.Affirmation": { "properties": { "signatories": { "items": { "$ref": "#/components/schemas/cyclonedx.Signatory" }, "type": "array", "uniqueItems": false }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "statement": { "type": "string" } }, "required": [ "signatories", "signature", "statement" ], "type": "object" }, "cyclonedx.Annotation": { "properties": { "annotator": { "$ref": "#/components/schemas/cyclonedx.Annotator" }, "bom-ref": { "type": "string" }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "subjects": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "text": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "annotator", "bom-ref", "signature", "subjects", "text", "timestamp" ], "type": "object" }, "cyclonedx.Annotator": { "properties": { "component": { "$ref": "#/components/schemas/cyclonedx.Component" }, "individual": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "organization": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "service": { "$ref": "#/components/schemas/cyclonedx.Service" } }, "required": [ "component", "individual", "organization", "service" ], "type": "object" }, "cyclonedx.AsserterChoice": { "properties": { "individual": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "organization": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "ref": { "type": "string" } }, "required": [ "individual", "organization", "ref" ], "type": "object" }, "cyclonedx.Assessor": { "properties": { "bom-ref": { "type": "string" }, "organization": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "thirdParty": { "type": "boolean" } }, "required": [ "bom-ref", "organization", "thirdParty" ], "type": "object" }, "cyclonedx.AttachedText": { "properties": { "content": { "type": "string" }, "contentType": { "type": "string" }, "encoding": { "type": "string" } }, "required": [ "content", "contentType", "encoding" ], "type": "object" }, "cyclonedx.Attestation": { "properties": { "assessor": { "type": "string" }, "map": { "items": { "$ref": "#/components/schemas/cyclonedx.AttestationMap" }, "type": "array", "uniqueItems": false }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "summary": { "type": "string" } }, "required": [ "assessor", "map", "signature", "summary" ], "type": "object" }, "cyclonedx.AttestationConfidence": { "properties": { "rationale": { "type": "string" }, "score": { "type": "number" } }, "required": [ "rationale", "score" ], "type": "object" }, "cyclonedx.AttestationConformance": { "properties": { "mitigationStrategies": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "rationale": { "type": "string" }, "score": { "type": "number" } }, "required": [ "mitigationStrategies", "rationale", "score" ], "type": "object" }, "cyclonedx.AttestationMap": { "properties": { "claims": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "confidence": { "$ref": "#/components/schemas/cyclonedx.AttestationConfidence" }, "conformance": { "$ref": "#/components/schemas/cyclonedx.AttestationConformance" }, "counterClaims": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "requirement": { "type": "string" } }, "required": [ "claims", "confidence", "conformance", "counterClaims", "requirement" ], "type": "object" }, "cyclonedx.BOM": { "properties": { "$schema": { "description": "JSON specific fields", "type": "string" }, "annotations": { "items": { "$ref": "#/components/schemas/cyclonedx.Annotation" }, "type": "array", "uniqueItems": false }, "bomFormat": { "type": "string" }, "citations": { "items": { "$ref": "#/components/schemas/cyclonedx.Citation" }, "type": "array", "uniqueItems": false }, "components": { "items": { "$ref": "#/components/schemas/cyclonedx.Component" }, "type": "array", "uniqueItems": false }, "compositions": { "items": { "$ref": "#/components/schemas/cyclonedx.Composition" }, "type": "array", "uniqueItems": false }, "declarations": { "$ref": "#/components/schemas/cyclonedx.Declarations" }, "definitions": { "$ref": "#/components/schemas/cyclonedx.Definitions" }, "dependencies": { "items": { "$ref": "#/components/schemas/cyclonedx.Dependency" }, "type": "array", "uniqueItems": false }, "externalReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "type": "array", "uniqueItems": false }, "formulation": { "items": { "$ref": "#/components/schemas/cyclonedx.Formula" }, "type": "array", "uniqueItems": false }, "metadata": { "$ref": "#/components/schemas/cyclonedx.Metadata" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "serialNumber": { "type": "string" }, "services": { "items": { "$ref": "#/components/schemas/cyclonedx.Service" }, "type": "array", "uniqueItems": false }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "specVersion": { "$ref": "#/components/schemas/cyclonedx.SpecVersion" }, "version": { "type": "integer" }, "vulnerabilities": { "items": { "$ref": "#/components/schemas/cyclonedx.Vulnerability" }, "type": "array", "uniqueItems": false } }, "required": [ "$schema", "annotations", "bomFormat", "citations", "components", "compositions", "declarations", "definitions", "dependencies", "externalReferences", "formulation", "metadata", "properties", "serialNumber", "services", "signature", "specVersion", "version", "vulnerabilities" ], "type": "object" }, "cyclonedx.Callstack": { "properties": { "frames": { "items": { "$ref": "#/components/schemas/cyclonedx.CallstackFrame" }, "type": "array", "uniqueItems": false } }, "required": [ "frames" ], "type": "object" }, "cyclonedx.CallstackFrame": { "properties": { "column": { "type": "integer" }, "fullFilename": { "type": "string" }, "function": { "type": "string" }, "line": { "type": "integer" }, "module": { "type": "string" }, "package": { "type": "string" }, "parameters": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "column", "fullFilename", "function", "line", "module", "package", "parameters" ], "type": "object" }, "cyclonedx.CertificateExtension": { "type": "object" }, "cyclonedx.CertificateProperties": { "properties": { "activationDate": { "description": "New in 1.7", "type": "string" }, "certificateExtension": { "description": "Deprecated in 1.7: use CertificateFileExtension", "type": "string" }, "certificateExtensions": { "description": "New in 1.7", "items": { "$ref": "#/components/schemas/cyclonedx.CertificateExtension" }, "type": "array", "uniqueItems": false }, "certificateFileExtension": { "description": "New in 1.7", "type": "string" }, "certificateFormat": { "type": "string" }, "certificateState": { "description": "New in 1.7", "items": { "$ref": "#/components/schemas/cyclonedx.CertificateState" }, "type": "array", "uniqueItems": false }, "creationDate": { "description": "New in 1.7", "type": "string" }, "deactivationDate": { "description": "New in 1.7", "type": "string" }, "destructionDate": { "description": "New in 1.7", "type": "string" }, "fingerprint": { "$ref": "#/components/schemas/cyclonedx.Hash", "description": "New in 1.7" }, "issuerName": { "type": "string" }, "notValidAfter": { "type": "string" }, "notValidBefore": { "type": "string" }, "relatedCryptographicAssets": { "description": "New in 1.7", "items": { "$ref": "#/components/schemas/cyclonedx.RelatedCryptographicAsset" }, "type": "array", "uniqueItems": false }, "revocationDate": { "description": "New in 1.7", "type": "string" }, "serialNumber": { "type": "string" }, "signatureAlgorithmRef": { "description": "Deprecated in 1.7: use RelatedCryptographicAssets", "type": "string" }, "subjectName": { "type": "string" }, "subjectPublicKeyRef": { "description": "Deprecated in 1.7: use RelatedCryptographicAssets", "type": "string" } }, "required": [ "activationDate", "certificateExtension", "certificateExtensions", "certificateFileExtension", "certificateFormat", "certificateState", "creationDate", "deactivationDate", "destructionDate", "fingerprint", "issuerName", "notValidAfter", "notValidBefore", "relatedCryptographicAssets", "revocationDate", "serialNumber", "signatureAlgorithmRef", "subjectName", "subjectPublicKeyRef" ], "type": "object" }, "cyclonedx.CertificateState": { "type": "object" }, "cyclonedx.CipherSuite": { "properties": { "algorithms": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "identifiers": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "tlsGroups": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "tlsSignatureSchemes": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "algorithms", "identifiers", "name", "tlsGroups", "tlsSignatureSchemes" ], "type": "object" }, "cyclonedx.Citation": { "properties": { "attributedTo": { "type": "string" }, "bom-ref": { "type": "string" }, "expressions": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "note": { "type": "string" }, "pointers": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "process": { "type": "string" }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "timestamp": { "type": "string" } }, "required": [ "attributedTo", "bom-ref", "expressions", "note", "pointers", "process", "signature", "timestamp" ], "type": "object" }, "cyclonedx.Claim": { "properties": { "bom-ref": { "type": "string" }, "counterEvidence": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "evidence": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "externalReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "type": "array", "uniqueItems": false }, "mitigationStrategies": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "predicate": { "type": "string" }, "reasoning": { "type": "string" }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "target": { "type": "string" } }, "required": [ "bom-ref", "counterEvidence", "evidence", "externalReferences", "mitigationStrategies", "predicate", "reasoning", "signature", "target" ], "type": "object" }, "cyclonedx.Commit": { "properties": { "author": { "$ref": "#/components/schemas/cyclonedx.IdentifiableAction" }, "committer": { "$ref": "#/components/schemas/cyclonedx.IdentifiableAction" }, "message": { "type": "string" }, "uid": { "type": "string" }, "url": { "type": "string" } }, "required": [ "author", "committer", "message", "uid", "url" ], "type": "object" }, "cyclonedx.Component": { "properties": { "author": { "description": "Deprecated: Use authors or manufacturer instead.", "type": "string" }, "authors": { "items": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "type": "array", "uniqueItems": false }, "bom-ref": { "type": "string" }, "components": { "items": { "$ref": "#/components/schemas/cyclonedx.Component" }, "type": "array", "uniqueItems": false }, "copyright": { "type": "string" }, "cpe": { "type": "string" }, "cryptoProperties": { "$ref": "#/components/schemas/cyclonedx.CryptoProperties" }, "data": { "items": { "$ref": "#/components/schemas/cyclonedx.ComponentData" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" }, "evidence": { "$ref": "#/components/schemas/cyclonedx.Evidence" }, "externalReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "type": "array", "uniqueItems": false }, "group": { "type": "string" }, "hashes": { "items": { "$ref": "#/components/schemas/cyclonedx.Hash" }, "type": "array", "uniqueItems": false }, "isExternal": { "type": "boolean" }, "licenses": { "items": { "$ref": "#/components/schemas/cyclonedx.LicenseChoice" }, "type": "array", "uniqueItems": false }, "manufacturer": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "mime-type": { "type": "string" }, "modelCard": { "$ref": "#/components/schemas/cyclonedx.MLModelCard" }, "modified": { "type": "boolean" }, "name": { "type": "string" }, "omniborId": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "patentAssertions": { "items": { "$ref": "#/components/schemas/cyclonedx.PatentAssertion" }, "type": "array", "uniqueItems": false }, "pedigree": { "$ref": "#/components/schemas/cyclonedx.Pedigree" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "publisher": { "type": "string" }, "purl": { "type": "string" }, "releaseNotes": { "$ref": "#/components/schemas/cyclonedx.ReleaseNotes" }, "scope": { "$ref": "#/components/schemas/cyclonedx.Scope" }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "supplier": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "swhid": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "swid": { "$ref": "#/components/schemas/cyclonedx.SWID" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "type": { "$ref": "#/components/schemas/cyclonedx.ComponentType" }, "version": { "type": "string" }, "versionRange": { "type": "string" } }, "required": [ "author", "authors", "bom-ref", "components", "copyright", "cpe", "cryptoProperties", "data", "description", "evidence", "externalReferences", "group", "hashes", "isExternal", "licenses", "manufacturer", "mime-type", "modelCard", "modified", "name", "omniborId", "patentAssertions", "pedigree", "properties", "publisher", "purl", "releaseNotes", "scope", "signature", "supplier", "swhid", "swid", "tags", "type", "version", "versionRange" ], "type": "object" }, "cyclonedx.ComponentData": { "properties": { "bom-ref": { "type": "string" }, "classification": { "type": "string" }, "contents": { "$ref": "#/components/schemas/cyclonedx.ComponentDataContents" }, "description": { "type": "string" }, "governance": { "$ref": "#/components/schemas/cyclonedx.DataGovernance" }, "graphics": { "$ref": "#/components/schemas/cyclonedx.ComponentDataGraphics" }, "name": { "type": "string" }, "sensitiveData": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "type": { "$ref": "#/components/schemas/cyclonedx.ComponentDataType" } }, "required": [ "bom-ref", "classification", "contents", "description", "governance", "graphics", "name", "sensitiveData", "type" ], "type": "object" }, "cyclonedx.ComponentDataContents": { "properties": { "attachment": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "url": { "type": "string" } }, "required": [ "attachment", "properties", "url" ], "type": "object" }, "cyclonedx.ComponentDataGovernanceResponsibleParty": { "properties": { "contact": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "organization": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" } }, "required": [ "contact", "organization" ], "type": "object" }, "cyclonedx.ComponentDataGraphic": { "properties": { "image": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "name": { "type": "string" } }, "required": [ "image", "name" ], "type": "object" }, "cyclonedx.ComponentDataGraphics": { "properties": { "collection": { "items": { "$ref": "#/components/schemas/cyclonedx.ComponentDataGraphic" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" } }, "required": [ "collection", "description" ], "type": "object" }, "cyclonedx.ComponentDataType": { "enum": [ "configuration", "dataset", "definition", "other", "source-code" ], "type": "string", "x-enum-varnames": [ "ComponentDataTypeConfiguration", "ComponentDataTypeDataset", "ComponentDataTypeDefinition", "ComponentDataTypeOther", "ComponentDataTypeSourceCode" ] }, "cyclonedx.ComponentType": { "enum": [ "application", "container", "cryptographic-asset", "data", "device", "device-driver", "file", "firmware", "framework", "library", "machine-learning-model", "operating-system", "platform" ], "type": "string", "x-enum-varnames": [ "ComponentTypeApplication", "ComponentTypeContainer", "ComponentTypeCryptographicAsset", "ComponentTypeData", "ComponentTypeDevice", "ComponentTypeDeviceDriver", "ComponentTypeFile", "ComponentTypeFirmware", "ComponentTypeFramework", "ComponentTypeLibrary", "ComponentTypeMachineLearningModel", "ComponentTypeOS", "ComponentTypePlatform" ] }, "cyclonedx.Composition": { "properties": { "aggregate": { "$ref": "#/components/schemas/cyclonedx.CompositionAggregate" }, "assemblies": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "bom-ref": { "type": "string" }, "dependencies": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "vulnerabilities": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "aggregate", "assemblies", "bom-ref", "dependencies", "signature", "vulnerabilities" ], "type": "object" }, "cyclonedx.CompositionAggregate": { "enum": [ "complete", "incomplete", "incomplete_first_party_only", "incomplete_first_party_opensource_only", "incomplete_first_party_proprietary_only", "incomplete_third_party_only", "incomplete_third_party_opensource_only", "incomplete_third_party_proprietary_only", "not_specified", "unknown" ], "type": "string", "x-enum-varnames": [ "CompositionAggregateComplete", "CompositionAggregateIncomplete", "CompositionAggregateIncompleteFirstPartyOnly", "CompositionAggregateIncompleteFirstPartyOpenSourceOnly", "CompositionAggregateIncompleteFirstPartyProprietaryOnly", "CompositionAggregateIncompleteThirdPartyOnly", "CompositionAggregateIncompleteThirdPartyOpenSourceOnly", "CompositionAggregateIncompleteThirdPartyProprietaryOnly", "CompositionAggregateNotSpecified", "CompositionAggregateUnknown" ] }, "cyclonedx.Copyright": { "properties": { "text": { "type": "string" } }, "required": [ "text" ], "type": "object" }, "cyclonedx.Credits": { "properties": { "individuals": { "items": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "type": "array", "uniqueItems": false }, "organizations": { "items": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "type": "array", "uniqueItems": false } }, "required": [ "individuals", "organizations" ], "type": "object" }, "cyclonedx.CryptoAlgorithmMode": { "enum": [ "cbc", "ecb", "ccm", "gcm", "cfb", "ofb", "ctr", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "CryptoAlgorithmModeCBC", "CryptoAlgorithmModeECB", "CryptoAlgorithmModeCCM", "CryptoAlgorithmModeGCM", "CryptoAlgorithmModeCFB", "CryptoAlgorithmModeOFB", "CryptoAlgorithmModeCTR", "CryptoAlgorithmModeOther", "CryptoAlgorithmModeUnknown" ] }, "cyclonedx.CryptoAlgorithmProperties": { "properties": { "algorithmFamily": { "type": "string" }, "certificationLevel": { "items": { "$ref": "#/components/schemas/cyclonedx.CryptoCertificationLevel" }, "type": "array", "uniqueItems": false }, "classicalSecurityLevel": { "type": "integer" }, "cryptoFunctions": { "items": { "$ref": "#/components/schemas/cyclonedx.CryptoFunction" }, "type": "array", "uniqueItems": false }, "curve": { "description": "Deprecated in 1.7: use EllipticCurve instead", "type": "string" }, "ellipticCurve": { "type": "string" }, "executionEnvironment": { "$ref": "#/components/schemas/cyclonedx.CryptoExecutionEnvironment" }, "implementationPlatform": { "$ref": "#/components/schemas/cyclonedx.ImplementationPlatform" }, "mode": { "$ref": "#/components/schemas/cyclonedx.CryptoAlgorithmMode" }, "nistQuantumSecurityLevel": { "type": "integer" }, "padding": { "$ref": "#/components/schemas/cyclonedx.CryptoPadding" }, "parameterSetIdentifier": { "type": "string" }, "primitive": { "$ref": "#/components/schemas/cyclonedx.CryptoPrimitive" } }, "required": [ "algorithmFamily", "certificationLevel", "classicalSecurityLevel", "cryptoFunctions", "curve", "ellipticCurve", "executionEnvironment", "implementationPlatform", "mode", "nistQuantumSecurityLevel", "padding", "parameterSetIdentifier", "primitive" ], "type": "object" }, "cyclonedx.CryptoAssetType": { "enum": [ "algorithm", "certificate", "protocol", "related-crypto-material" ], "type": "string", "x-enum-varnames": [ "CryptoAssetTypeAlgorithm", "CryptoAssetTypeCertificate", "CryptoAssetTypeProtocol", "CryptoAssetTypeRelatedCryptoMaterial" ] }, "cyclonedx.CryptoCertificationLevel": { "enum": [ "none", "fips140-1-l1", "fips140-1-l2", "fips140-1-l3", "fips140-1-l4", "fips140-2-l1", "fips140-2-l2", "fips140-2-l3", "fips140-2-l4", "fips140-3-l1", "fips140-3-l2", "fips140-3-l3", "fips140-3-l4", "cc-eal1", "cc-eal1+", "cc-eal2", "cc-eal2+", "cc-eal3", "cc-eal3+", "cc-eal4", "cc-eal4+", "cc-eal5", "cc-eal5+", "cc-eal6", "cc-eal6+", "cc-eal7", "cc-eal7+", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "CryptoCertificationLevelNone", "CryptoCertificationLevelFIPS140_1_L1", "CryptoCertificationLevelFIPS140_1_L2", "CryptoCertificationLevelFIPS140_1_L3", "CryptoCertificationLevelFIPS140_1_L4", "CryptoCertificationLevelFIPS140_2_L1", "CryptoCertificationLevelFIPS140_2_L2", "CryptoCertificationLevelFIPS140_2_L3", "CryptoCertificationLevelFIPS140_2_L4", "CryptoCertificationLevelFIPS140_3_L1", "CryptoCertificationLevelFIPS140_3_L2", "CryptoCertificationLevelFIPS140_3_L3", "CryptoCertificationLevelFIPS140_3_L4", "CryptoCertificationLevelCCEAL1", "CryptoCertificationLevelCCEAL1Plus", "CryptoCertificationLevelCCEAL2", "CryptoCertificationLevelCCEAL2Plus", "CryptoCertificationLevelCCEAL3", "CryptoCertificationLevelCCEAL3Plus", "CryptoCertificationLevelCCEAL4", "CryptoCertificationLevelCCEAL4Plus", "CryptoCertificationLevelCCEAL5", "CryptoCertificationLevelCCEAL5Plus", "CryptoCertificationLevelCCEAL6", "CryptoCertificationLevelCCEAL6Plus", "CryptoCertificationLevelCCEAL7", "CryptoCertificationLevelCCEAL7Plus", "CryptoCertificationLevelOther", "CryptoCertificationLevelUnknown" ] }, "cyclonedx.CryptoExecutionEnvironment": { "enum": [ "software-plain-ram", "software-encrypted-ram", "software-tee", "hardware", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "CryptoExecutionEnvironmentSoftwarePlainRAM", "CryptoExecutionEnvironmentSoftwareEncryptedRAM", "CryptoExecutionEnvironmentSoftwareTEE", "CryptoExecutionEnvironmentHardware", "CryptoExecutionEnvironmentOther", "CryptoExecutionEnvironmentUnknown" ] }, "cyclonedx.CryptoFunction": { "enum": [ "generate", "keygen", "encrypt", "decrypt", "digest", "tag", "keyderive", "sign", "verify", "encapsulate", "decapsulate", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "CryptoFunctionGenerate", "CryptoFunctionKeygen", "CryptoFunctionEncrypt", "CryptoFunctionDecrypt", "CryptoFunctionDigest", "CryptoFunctionTag", "CryptoFunctionKeyderive", "CryptoFunctionSign", "CryptoFunctionVerify", "CryptoFunctionEncapsulate", "CryptoFunctionDecapsulate", "CryptoFunctionOther", "CryptoFunctionUnknown" ] }, "cyclonedx.CryptoKeyState": { "enum": [ "pre-activation", "active", "suspended", "deactivated", "compromised", "destroyed" ], "type": "string", "x-enum-varnames": [ "CryptoKeyStatePreActivation", "CryptoKeyStateActive", "CryptoKeyStateSuspended", "CryptoKeyStateDeactivated", "CryptoKeyStateCompromised", "CryptoKeyStateDestroyed" ] }, "cyclonedx.CryptoPadding": { "enum": [ "pkcs5", "pkcs7", "pkcs1v15", "oaep", "raw", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "CryptoPaddingPKCS5", "CryptoPaddingPKCS7", "CryptoPaddingPKCS1v15", "CryptoPaddingOAEP", "CryptoPaddingRaw", "CryptoPaddingOther", "CryptoPaddingUnknown" ] }, "cyclonedx.CryptoPrimitive": { "enum": [ "drbg", "mac", "block-cipher", "stream-cipher", "signature", "hash", "pke", "xof", "kdf", "key-agree", "kem", "ae", "combiner", "key-wrap", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "CryptoPrimitiveDRBG", "CryptoPrimitiveMAC", "CryptoPrimitiveBlockCipher", "CryptoPrimitiveStreamCipher", "CryptoPrimitiveSignature", "CryptoPrimitiveHash", "CryptoPrimitivePKE", "CryptoPrimitiveXOF", "CryptoPrimitiveKDF", "CryptoPrimitiveKeyAgree", "CryptoPrimitiveKEM", "CryptoPrimitiveAE", "CryptoPrimitiveCombiner", "CryptoPrimitiveKeyWrap", "CryptoPrimitiveOther", "CryptoPrimitiveUnknown" ] }, "cyclonedx.CryptoProperties": { "properties": { "algorithmProperties": { "$ref": "#/components/schemas/cyclonedx.CryptoAlgorithmProperties" }, "assetType": { "$ref": "#/components/schemas/cyclonedx.CryptoAssetType" }, "certificateProperties": { "$ref": "#/components/schemas/cyclonedx.CertificateProperties" }, "oid": { "type": "string" }, "protocolProperties": { "$ref": "#/components/schemas/cyclonedx.CryptoProtocolProperties" }, "relatedCryptoMaterialProperties": { "$ref": "#/components/schemas/cyclonedx.RelatedCryptoMaterialProperties" } }, "required": [ "algorithmProperties", "assetType", "certificateProperties", "oid", "protocolProperties", "relatedCryptoMaterialProperties" ], "type": "object" }, "cyclonedx.CryptoProtocolProperties": { "properties": { "cipherSuites": { "items": { "$ref": "#/components/schemas/cyclonedx.CipherSuite" }, "type": "array", "uniqueItems": false }, "cryptoRefArray": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "ikev2TransformTypes": { "$ref": "#/components/schemas/cyclonedx.IKEv2TransformTypes" }, "relatedCryptographicAssets": { "description": "New in 1.7", "items": { "$ref": "#/components/schemas/cyclonedx.RelatedCryptographicAsset" }, "type": "array", "uniqueItems": false }, "type": { "$ref": "#/components/schemas/cyclonedx.CryptoProtocolType" }, "version": { "type": "string" } }, "required": [ "cipherSuites", "cryptoRefArray", "ikev2TransformTypes", "relatedCryptographicAssets", "type", "version" ], "type": "object" }, "cyclonedx.CryptoProtocolType": { "enum": [ "tls", "ssh", "ipsec", "ike", "sstp", "wpa", "dtls", "quic", "eap-aka", "eap-aka-prime", "prins", "5g-aka", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "CryptoProtocolTypeTLS", "CryptoProtocolTypeSSH", "CryptoProtocolTypeIPSec", "CryptoProtocolTypeIKE", "CryptoProtocolTypeSSTP", "CryptoProtocolTypeWPA", "CryptoProtocolTypeDTLS", "CryptoProtocolTypeQUIC", "CryptoProtocolTypeEAPAKA", "CryptoProtocolTypeEAPAKAPrime", "CryptoProtocolTypePRINS", "CryptoProtocolType5GAKA", "CryptoProtocolTypeOther", "CryptoProtocolTypeUnknown" ] }, "cyclonedx.DataClassification": { "properties": { "classification": { "type": "string" }, "description": { "type": "string" }, "destination": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "flow": { "$ref": "#/components/schemas/cyclonedx.DataFlow" }, "governance": { "$ref": "#/components/schemas/cyclonedx.DataGovernance" }, "name": { "type": "string" }, "source": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "classification", "description", "destination", "flow", "governance", "name", "source" ], "type": "object" }, "cyclonedx.DataFlow": { "enum": [ "bi-directional", "inbound", "outbound", "unknown" ], "type": "string", "x-enum-varnames": [ "DataFlowBidirectional", "DataFlowInbound", "DataFlowOutbound", "DataFlowUnknown" ] }, "cyclonedx.DataGovernance": { "properties": { "custodians": { "items": { "$ref": "#/components/schemas/cyclonedx.ComponentDataGovernanceResponsibleParty" }, "type": "array", "uniqueItems": false }, "owners": { "items": { "$ref": "#/components/schemas/cyclonedx.ComponentDataGovernanceResponsibleParty" }, "type": "array", "uniqueItems": false }, "stewards": { "items": { "$ref": "#/components/schemas/cyclonedx.ComponentDataGovernanceResponsibleParty" }, "type": "array", "uniqueItems": false } }, "required": [ "custodians", "owners", "stewards" ], "type": "object" }, "cyclonedx.DeclarationEvidence": { "properties": { "author": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "bom-ref": { "type": "string" }, "created": { "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/cyclonedx.EvidenceData" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" }, "expires": { "type": "string" }, "propertyName": { "type": "string" }, "reviewer": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" } }, "required": [ "author", "bom-ref", "created", "data", "description", "expires", "propertyName", "reviewer", "signature" ], "type": "object" }, "cyclonedx.Declarations": { "properties": { "affirmation": { "$ref": "#/components/schemas/cyclonedx.Affirmation" }, "assessors": { "items": { "$ref": "#/components/schemas/cyclonedx.Assessor" }, "type": "array", "uniqueItems": false }, "attestations": { "items": { "$ref": "#/components/schemas/cyclonedx.Attestation" }, "type": "array", "uniqueItems": false }, "claims": { "items": { "$ref": "#/components/schemas/cyclonedx.Claim" }, "type": "array", "uniqueItems": false }, "evidence": { "items": { "$ref": "#/components/schemas/cyclonedx.DeclarationEvidence" }, "type": "array", "uniqueItems": false }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "targets": { "$ref": "#/components/schemas/cyclonedx.Targets" } }, "required": [ "affirmation", "assessors", "attestations", "claims", "evidence", "signature", "targets" ], "type": "object" }, "cyclonedx.Definitions": { "properties": { "patents": { "items": { "$ref": "#/components/schemas/cyclonedx.PatentChoice" }, "type": "array", "uniqueItems": false }, "standards": { "items": { "$ref": "#/components/schemas/cyclonedx.StandardDefinition" }, "type": "array", "uniqueItems": false } }, "required": [ "patents", "standards" ], "type": "object" }, "cyclonedx.Dependency": { "properties": { "dependsOn": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "provides": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "ref": { "type": "string" } }, "required": [ "dependsOn", "provides", "ref" ], "type": "object" }, "cyclonedx.Diff": { "properties": { "text": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "url": { "type": "string" } }, "required": [ "text", "url" ], "type": "object" }, "cyclonedx.DistributionConstraints": { "properties": { "tlp": { "$ref": "#/components/schemas/cyclonedx.TLPClassification" } }, "required": [ "tlp" ], "type": "object" }, "cyclonedx.EnvironmentVariableChoice": { "type": "object" }, "cyclonedx.Event": { "properties": { "data": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "description": { "type": "string" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "source": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "target": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "timeReceived": { "type": "string" }, "uid": { "type": "string" } }, "required": [ "data", "description", "properties", "source", "target", "timeReceived", "uid" ], "type": "object" }, "cyclonedx.Evidence": { "properties": { "callstack": { "$ref": "#/components/schemas/cyclonedx.Callstack" }, "copyright": { "items": { "$ref": "#/components/schemas/cyclonedx.Copyright" }, "type": "array", "uniqueItems": false }, "identity": { "$ref": "#/components/schemas/cyclonedx.EvidenceIdentityChoice" }, "licenses": { "items": { "$ref": "#/components/schemas/cyclonedx.LicenseChoice" }, "type": "array", "uniqueItems": false }, "occurrences": { "items": { "$ref": "#/components/schemas/cyclonedx.EvidenceOccurrence" }, "type": "array", "uniqueItems": false } }, "required": [ "callstack", "copyright", "identity", "licenses", "occurrences" ], "type": "object" }, "cyclonedx.EvidenceData": { "properties": { "classification": { "$ref": "#/components/schemas/cyclonedx.DataClassification" }, "contents": { "$ref": "#/components/schemas/cyclonedx.EvidenceDataContents" }, "governance": { "$ref": "#/components/schemas/cyclonedx.DataGovernance" }, "name": { "type": "string" }, "sensitiveData": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "classification", "contents", "governance", "name", "sensitiveData" ], "type": "object" }, "cyclonedx.EvidenceDataContents": { "properties": { "attachment": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "url": { "type": "string" } }, "required": [ "attachment", "url" ], "type": "object" }, "cyclonedx.EvidenceIdentityChoice": { "type": "object" }, "cyclonedx.EvidenceOccurrence": { "properties": { "additionalContext": { "type": "string" }, "bom-ref": { "type": "string" }, "line": { "type": "integer" }, "location": { "type": "string" }, "offset": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "additionalContext", "bom-ref", "line", "location", "offset", "symbol" ], "type": "object" }, "cyclonedx.ExternalReference": { "properties": { "comment": { "type": "string" }, "hashes": { "items": { "$ref": "#/components/schemas/cyclonedx.Hash" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "type": { "$ref": "#/components/schemas/cyclonedx.ExternalReferenceType" }, "url": { "type": "string" } }, "required": [ "comment", "hashes", "properties", "type", "url" ], "type": "object" }, "cyclonedx.ExternalReferenceType": { "enum": [ "adversary-model", "advisories", "attestation", "bom", "build-meta", "build-system", "certification-report", "chat", "configuration", "codified-infrastructure", "component-analysis-report", "distribution", "distribution-intake", "documentation", "dynamic-analysis-report", "digital-signature", "electronic-signature", "evidence", "exploitability-statement", "formulation", "issue-tracker", "license", "log", "mailing-list", "maturity-report", "model-card", "other", "pentest-report", "poam", "quality-metrics", "release-notes", "risk-assessment", "rfc-9116", "runtime-analysis-report", "security-contact", "social", "source-distribution", "static-analysis-report", "support", "threat-model", "vcs", "vulnerability-assertion", "website", "patent", "patent-family", "patent-assertion", "citation" ], "type": "string", "x-enum-varnames": [ "ERTypeAdversaryModel", "ERTypeAdvisories", "ERTypeAttestation", "ERTypeBOM", "ERTypeBuildMeta", "ERTypeBuildSystem", "ERTypeCertificationReport", "ERTypeChat", "ERTypeConfiguration", "ERTypeCodifiedInfrastructure", "ERTypeComponentAnalysisReport", "ERTypeDistribution", "ERTypeDistributionIntake", "ERTypeDocumentation", "ERTypeDynamicAnalysisReport", "ERTypeDigitalSignature", "ERTypeElectronicSignature", "ERTypeEvidence", "ERTypeExploitabilityStatement", "ERTypeFormulation", "ERTypeIssueTracker", "ERTypeLicense", "ERTypeLog", "ERTypeMailingList", "ERTypeMaturityReport", "ERTypeModelCard", "ERTypeOther", "ERTypePentestReport", "ERTypePOAM", "ERTypeQualityMetrics", "ERTypeReleaseNotes", "ERTypeRiskAssessment", "ERTypeRFC9116", "ERTypeRuntimeAnalysisReport", "ERTypeSecurityContact", "ERTypeSocial", "ERTypeSourceDistribution", "ERTypeStaticAnalysisReport", "ERTypeSupport", "ERTypeThreatModel", "ERTypeVCS", "ERTypeVulnerabilityAssertion", "ERTypeWebsite", "ERTypePatent", "ERTypePatentFamily", "ERTypePatentAssertion", "ERTypeCitation" ] }, "cyclonedx.Formula": { "properties": { "bom-ref": { "type": "string" }, "components": { "items": { "$ref": "#/components/schemas/cyclonedx.Component" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "services": { "items": { "$ref": "#/components/schemas/cyclonedx.Service" }, "type": "array", "uniqueItems": false }, "workflows": { "items": { "$ref": "#/components/schemas/cyclonedx.Workflow" }, "type": "array", "uniqueItems": false } }, "required": [ "bom-ref", "components", "properties", "services", "workflows" ], "type": "object" }, "cyclonedx.Hash": { "properties": { "alg": { "$ref": "#/components/schemas/cyclonedx.HashAlgorithm" }, "content": { "type": "string" } }, "required": [ "alg", "content" ], "type": "object" }, "cyclonedx.HashAlgorithm": { "enum": [ "MD5", "SHA-1", "SHA-256", "SHA-384", "SHA-512", "SHA3-256", "SHA3-384", "SHA3-512", "BLAKE2b-256", "BLAKE2b-384", "BLAKE2b-512", "BLAKE3", "Streebog-256", "Streebog-512" ], "type": "string", "x-enum-varnames": [ "HashAlgoMD5", "HashAlgoSHA1", "HashAlgoSHA256", "HashAlgoSHA384", "HashAlgoSHA512", "HashAlgoSHA3_256", "HashAlgoSHA3_384", "HashAlgoSHA3_512", "HashAlgoBlake2b_256", "HashAlgoBlake2b_384", "HashAlgoBlake2b_512", "HashAlgoBlake3", "HashAlgoStreebog256", "HashAlgoStreebog512" ] }, "cyclonedx.IKEv2Auth": { "properties": { "algorithm": { "type": "string" }, "name": { "type": "string" } }, "required": [ "algorithm", "name" ], "type": "object" }, "cyclonedx.IKEv2Enc": { "properties": { "algorithm": { "type": "string" }, "keyLength": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "algorithm", "keyLength", "name" ], "type": "object" }, "cyclonedx.IKEv2Integ": { "properties": { "algorithm": { "type": "string" }, "name": { "type": "string" } }, "required": [ "algorithm", "name" ], "type": "object" }, "cyclonedx.IKEv2Ke": { "properties": { "algorithm": { "type": "string" }, "group": { "type": "integer" } }, "required": [ "algorithm", "group" ], "type": "object" }, "cyclonedx.IKEv2Prf": { "properties": { "algorithm": { "type": "string" }, "name": { "type": "string" } }, "required": [ "algorithm", "name" ], "type": "object" }, "cyclonedx.IKEv2TransformTypes": { "properties": { "auth": { "items": { "$ref": "#/components/schemas/cyclonedx.IKEv2Auth" }, "type": "array", "uniqueItems": false }, "encr": { "items": { "$ref": "#/components/schemas/cyclonedx.IKEv2Enc" }, "type": "array", "uniqueItems": false }, "esn": { "type": "boolean" }, "integ": { "items": { "$ref": "#/components/schemas/cyclonedx.IKEv2Integ" }, "type": "array", "uniqueItems": false }, "ke": { "items": { "$ref": "#/components/schemas/cyclonedx.IKEv2Ke" }, "type": "array", "uniqueItems": false }, "prf": { "items": { "$ref": "#/components/schemas/cyclonedx.IKEv2Prf" }, "type": "array", "uniqueItems": false } }, "required": [ "auth", "encr", "esn", "integ", "ke", "prf" ], "type": "object" }, "cyclonedx.IdentifiableAction": { "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "email", "name", "timestamp" ], "type": "object" }, "cyclonedx.ImpactAnalysisJustification": { "enum": [ "code_not_present", "code_not_reachable", "requires_configuration", "requires_dependency", "requires_environment", "protected_by_compiler", "protected_at_runtime", "protected_at_perimeter", "protected_by_mitigating_control" ], "type": "string", "x-enum-varnames": [ "IAJCodeNotPresent", "IAJCodeNotReachable", "IAJRequiresConfiguration", "IAJRequiresDependency", "IAJRequiresEnvironment", "IAJProtectedByCompiler", "IAJProtectedAtRuntime", "IAJProtectedAtPerimeter", "IAJProtectedByMitigatingControl" ] }, "cyclonedx.ImpactAnalysisResponse": { "enum": [ "can_not_fix", "will_not_fix", "update", "rollback", "workaround_available" ], "type": "string", "x-enum-varnames": [ "IARCanNotFix", "IARWillNotFix", "IARUpdate", "IARRollback", "IARWorkaroundAvailable" ] }, "cyclonedx.ImpactAnalysisState": { "enum": [ "resolved", "resolved_with_pedigree", "exploitable", "in_triage", "false_positive", "not_affected" ], "type": "string", "x-enum-varnames": [ "IASResolved", "IASResolvedWithPedigree", "IASExploitable", "IASInTriage", "IASFalsePositive", "IASNotAffected" ] }, "cyclonedx.ImplementationPlatform": { "enum": [ "generic", "x86_32", "x86_64", "armv7-a", "armv7-m", "armv8-a", "armv8-m", "armv9-a", "armv9-m", "s390x", "ppc64", "ppc64le", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "ImplementationPlatformGeneric", "ImplementationPlatformX86_32", "ImplementationPlatformX86_64", "ImplementationPlatformARMv7A", "ImplementationPlatformARMv7M", "ImplementationPlatformARMv8A", "ImplementationPlatformARMv8M", "ImplementationPlatformARMv9A", "ImplementationPlatformARMv9M", "ImplementationPlatformS390x", "ImplementationPlatformPPC64", "ImplementationPlatformPPC64LE", "ImplementationPlatformOther", "ImplementationPlatformUnknown" ] }, "cyclonedx.Issue": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "references": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "source": { "$ref": "#/components/schemas/cyclonedx.Source" }, "type": { "$ref": "#/components/schemas/cyclonedx.IssueType" } }, "required": [ "description", "id", "name", "references", "source", "type" ], "type": "object" }, "cyclonedx.IssueType": { "enum": [ "defect", "enhancement", "security" ], "type": "string", "x-enum-varnames": [ "IssueTypeDefect", "IssueTypeEnhancement", "IssueTypeSecurity" ] }, "cyclonedx.JSFPublicKey": { "properties": { "crv": { "type": "string" }, "e": { "type": "string" }, "kty": { "type": "string" }, "n": { "type": "string" }, "x": { "type": "string" }, "y": { "type": "string" } }, "required": [ "crv", "e", "kty", "n", "x", "y" ], "type": "object" }, "cyclonedx.JSFSignature": { "properties": { "chain": { "items": { "$ref": "#/components/schemas/cyclonedx.JSFSigner" }, "type": "array", "uniqueItems": false }, "signers": { "items": { "$ref": "#/components/schemas/cyclonedx.JSFSigner" }, "type": "array", "uniqueItems": false } }, "required": [ "chain", "signers" ], "type": "object" }, "cyclonedx.JSFSigner": { "properties": { "algorithm": { "type": "string" }, "certificatePath": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "excludes": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "keyId": { "type": "string" }, "publicKey": { "$ref": "#/components/schemas/cyclonedx.JSFPublicKey" }, "value": { "type": "string" } }, "required": [ "algorithm", "certificatePath", "excludes", "keyId", "publicKey", "value" ], "type": "object" }, "cyclonedx.License": { "properties": { "acknowledgement": { "$ref": "#/components/schemas/cyclonedx.LicenseAcknowledgement" }, "bom-ref": { "type": "string" }, "id": { "type": "string" }, "licensing": { "$ref": "#/components/schemas/cyclonedx.Licensing" }, "name": { "type": "string" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "text": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "url": { "type": "string" } }, "required": [ "acknowledgement", "bom-ref", "id", "licensing", "name", "properties", "text", "url" ], "type": "object" }, "cyclonedx.LicenseAcknowledgement": { "enum": [ "declared", "concluded" ], "type": "string", "x-enum-varnames": [ "LicenseAcknowledgementDeclared", "LicenseAcknowledgementConcluded" ] }, "cyclonedx.LicenseChoice": { "properties": { "acknowledgement": { "$ref": "#/components/schemas/cyclonedx.LicenseAcknowledgement" }, "bom-ref": { "type": "string" }, "expression": { "type": "string" }, "expressionDetails": { "items": { "$ref": "#/components/schemas/cyclonedx.LicenseExpressionDetail" }, "type": "array", "uniqueItems": false }, "license": { "$ref": "#/components/schemas/cyclonedx.License" }, "licensing": { "$ref": "#/components/schemas/cyclonedx.Licensing" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false } }, "required": [ "acknowledgement", "bom-ref", "expression", "expressionDetails", "license", "licensing", "properties" ], "type": "object" }, "cyclonedx.LicenseExpressionDetail": { "properties": { "bom-ref": { "type": "string" }, "licenseIdentifier": { "type": "string" }, "text": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "url": { "type": "string" } }, "required": [ "bom-ref", "licenseIdentifier", "text", "url" ], "type": "object" }, "cyclonedx.LicenseType": { "enum": [ "academic", "appliance", "client-access", "concurrent-user", "core-points", "custom-metric", "device", "evaluation", "named-user", "node-locked", "oem", "other", "perpetual", "processor-points", "subscription", "user" ], "type": "string", "x-enum-varnames": [ "LicenseTypeAcademic", "LicenseTypeAppliance", "LicenseTypeClientAccess", "LicenseTypeConcurrentUser", "LicenseTypeCorePoints", "LicenseTypeCustomMetric", "LicenseTypeDevice", "LicenseTypeEvaluation", "LicenseTypeNamedUser", "LicenseTypeNodeLocked", "LicenseTypeOEM", "LicenseTypeOther", "LicenseTypePerpetual", "LicenseTypeProcessorPoints", "LicenseTypeSubscription", "LicenseTypeUser" ] }, "cyclonedx.Licensing": { "properties": { "altIds": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "expiration": { "type": "string" }, "lastRenewal": { "type": "string" }, "licenseTypes": { "items": { "$ref": "#/components/schemas/cyclonedx.LicenseType" }, "type": "array", "uniqueItems": false }, "licensee": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntityOrContact" }, "licensor": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntityOrContact" }, "purchaseOrder": { "type": "string" }, "purchaser": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntityOrContact" } }, "required": [ "altIds", "expiration", "lastRenewal", "licenseTypes", "licensee", "licensor", "purchaseOrder", "purchaser" ], "type": "object" }, "cyclonedx.Lifecycle": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/cyclonedx.LifecyclePhase" } }, "required": [ "description", "name", "phase" ], "type": "object" }, "cyclonedx.LifecyclePhase": { "enum": [ "build", "decommission", "design", "discovery", "operations", "post-build", "pre-build" ], "type": "string", "x-enum-varnames": [ "LifecyclePhaseBuild", "LifecyclePhaseDecommission", "LifecyclePhaseDesign", "LifecyclePhaseDiscovery", "LifecyclePhaseOperations", "LifecyclePhasePostBuild", "LifecyclePhasePreBuild" ] }, "cyclonedx.MLDatasetChoice": { "type": "object" }, "cyclonedx.MLInputOutputParameters": { "properties": { "format": { "type": "string" } }, "required": [ "format" ], "type": "object" }, "cyclonedx.MLModelCO2Measure": { "properties": { "unit": { "$ref": "#/components/schemas/cyclonedx.MLModelCO2Unit" }, "value": { "type": "number" } }, "required": [ "unit", "value" ], "type": "object" }, "cyclonedx.MLModelCO2Unit": { "enum": [ "tCO2eq" ], "type": "string", "x-enum-varnames": [ "MLModelCO2UnitTCO2Eq" ] }, "cyclonedx.MLModelCard": { "properties": { "bom-ref": { "type": "string" }, "considerations": { "$ref": "#/components/schemas/cyclonedx.MLModelCardConsiderations" }, "modelParameters": { "$ref": "#/components/schemas/cyclonedx.MLModelParameters" }, "quantitativeAnalysis": { "$ref": "#/components/schemas/cyclonedx.MLQuantitativeAnalysis" } }, "required": [ "bom-ref", "considerations", "modelParameters", "quantitativeAnalysis" ], "type": "object" }, "cyclonedx.MLModelCardConsiderations": { "properties": { "environmentalConsiderations": { "$ref": "#/components/schemas/cyclonedx.MLModelCardEnvironmentalConsiderations" }, "ethicalConsiderations": { "items": { "$ref": "#/components/schemas/cyclonedx.MLModelCardEthicalConsideration" }, "type": "array", "uniqueItems": false }, "fairnessAssessments": { "items": { "$ref": "#/components/schemas/cyclonedx.MLModelCardFairnessAssessment" }, "type": "array", "uniqueItems": false }, "performanceTradeoffs": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "technicalLimitations": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "useCases": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "users": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "environmentalConsiderations", "ethicalConsiderations", "fairnessAssessments", "performanceTradeoffs", "technicalLimitations", "useCases", "users" ], "type": "object" }, "cyclonedx.MLModelCardEnvironmentalConsiderations": { "properties": { "energyConsumptions": { "items": { "$ref": "#/components/schemas/cyclonedx.MLModelEnergyConsumption" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false } }, "required": [ "energyConsumptions", "properties" ], "type": "object" }, "cyclonedx.MLModelCardEthicalConsideration": { "properties": { "mitigationStrategy": { "type": "string" }, "name": { "type": "string" } }, "required": [ "mitigationStrategy", "name" ], "type": "object" }, "cyclonedx.MLModelCardFairnessAssessment": { "properties": { "benefits": { "type": "string" }, "groupAtRisk": { "type": "string" }, "harms": { "type": "string" }, "mitigationStrategy": { "type": "string" } }, "required": [ "benefits", "groupAtRisk", "harms", "mitigationStrategy" ], "type": "object" }, "cyclonedx.MLModelEnergyConsumption": { "properties": { "activity": { "$ref": "#/components/schemas/cyclonedx.MLModelEnergyConsumptionActivity" }, "activityEnergyCost": { "$ref": "#/components/schemas/cyclonedx.MLModelEnergyMeasure" }, "co2CostEquivalent": { "$ref": "#/components/schemas/cyclonedx.MLModelCO2Measure" }, "co2CostOffset": { "$ref": "#/components/schemas/cyclonedx.MLModelCO2Measure" }, "energyProviders": { "items": { "$ref": "#/components/schemas/cyclonedx.MLModelEnergyProvider" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false } }, "required": [ "activity", "activityEnergyCost", "co2CostEquivalent", "co2CostOffset", "energyProviders", "properties" ], "type": "object" }, "cyclonedx.MLModelEnergyConsumptionActivity": { "enum": [ "design", "data-collection", "data-preparation", "training", "fine-tuning", "validation", "deployment", "inference", "other" ], "type": "string", "x-enum-varnames": [ "MLModelEnergyConsumptionActivityDesign", "MLModelEnergyConsumptionActivityDataCollection", "MLModelEnergyConsumptionActivityDataPreparation", "MLModelEnergyConsumptionActivityTraining", "MLModelEnergyConsumptionActivityFineTuning", "MLModelEnergyConsumptionActivityValidation", "MLModelEnergyConsumptionActivityDeployment", "MLModelEnergyConsumptionActivityInference", "MLModelEnergyConsumptionActivityOther" ] }, "cyclonedx.MLModelEnergyMeasure": { "properties": { "unit": { "$ref": "#/components/schemas/cyclonedx.MLModelEnergyUnit" }, "value": { "type": "number" } }, "required": [ "unit", "value" ], "type": "object" }, "cyclonedx.MLModelEnergyProvider": { "properties": { "bom-ref": { "type": "string" }, "description": { "type": "string" }, "energyProvided": { "$ref": "#/components/schemas/cyclonedx.MLModelEnergyMeasure" }, "energySource": { "$ref": "#/components/schemas/cyclonedx.MLModelEnergySource" }, "externalReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "type": "array", "uniqueItems": false }, "organization": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" } }, "required": [ "bom-ref", "description", "energyProvided", "energySource", "externalReferences", "organization" ], "type": "object" }, "cyclonedx.MLModelEnergySource": { "enum": [ "coal", "oil", "natural-gas", "nuclear", "wind", "solar", "geothermal", "hydropower", "biofuel", "unknown", "other" ], "type": "string", "x-enum-varnames": [ "MLModelEnergySourceCoal", "MLModelEnergySourceOil", "MLModelEnergySourceNaturalGas", "MLModelEnergySourceNuclear", "MLModelEnergySourceWind", "MLModelEnergySourceSolar", "MLModelEnergySourceGeothermal", "MLModelEnergySourceHydropower", "MLModelEnergySourceBiofuel", "MLModelEnergySourceUnknown", "MLModelEnergySourceOther" ] }, "cyclonedx.MLModelEnergyUnit": { "enum": [ "kWh" ], "type": "string", "x-enum-varnames": [ "MLModelEnergyUnitKWH" ] }, "cyclonedx.MLModelParameters": { "properties": { "approach": { "$ref": "#/components/schemas/cyclonedx.MLModelParametersApproach" }, "architectureFamily": { "type": "string" }, "datasets": { "items": { "$ref": "#/components/schemas/cyclonedx.MLDatasetChoice" }, "type": "array", "uniqueItems": false }, "inputs": { "items": { "$ref": "#/components/schemas/cyclonedx.MLInputOutputParameters" }, "type": "array", "uniqueItems": false }, "modelArchitecture": { "type": "string" }, "outputs": { "items": { "$ref": "#/components/schemas/cyclonedx.MLInputOutputParameters" }, "type": "array", "uniqueItems": false }, "task": { "type": "string" } }, "required": [ "approach", "architectureFamily", "datasets", "inputs", "modelArchitecture", "outputs", "task" ], "type": "object" }, "cyclonedx.MLModelParametersApproach": { "properties": { "type": { "$ref": "#/components/schemas/cyclonedx.MLModelParametersApproachType" } }, "required": [ "type" ], "type": "object" }, "cyclonedx.MLModelParametersApproachType": { "enum": [ "supervised", "unsupervised", "reinforcement-learning", "semi-supervised", "self-supervised" ], "type": "string", "x-enum-varnames": [ "MLModelParametersApproachTypeSupervised", "MLModelParametersApproachTypeUnsupervised", "MLModelParametersApproachTypeReinforcementLearning", "MLModelParametersApproachTypeSemiSupervised", "MLModelParametersApproachTypeSelfSupervised" ] }, "cyclonedx.MLPerformanceMetric": { "properties": { "confidenceInterval": { "$ref": "#/components/schemas/cyclonedx.MLPerformanceMetricConfidenceInterval" }, "slice": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "confidenceInterval", "slice", "type", "value" ], "type": "object" }, "cyclonedx.MLPerformanceMetricConfidenceInterval": { "properties": { "lowerBound": { "type": "string" }, "upperBound": { "type": "string" } }, "required": [ "lowerBound", "upperBound" ], "type": "object" }, "cyclonedx.MLQuantitativeAnalysis": { "properties": { "graphics": { "$ref": "#/components/schemas/cyclonedx.ComponentDataGraphics" }, "performanceMetrics": { "items": { "$ref": "#/components/schemas/cyclonedx.MLPerformanceMetric" }, "type": "array", "uniqueItems": false } }, "required": [ "graphics", "performanceMetrics" ], "type": "object" }, "cyclonedx.Metadata": { "properties": { "authors": { "items": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "type": "array", "uniqueItems": false }, "component": { "$ref": "#/components/schemas/cyclonedx.Component" }, "distributionConstraints": { "$ref": "#/components/schemas/cyclonedx.DistributionConstraints" }, "licenses": { "items": { "$ref": "#/components/schemas/cyclonedx.LicenseChoice" }, "type": "array", "uniqueItems": false }, "lifecycles": { "items": { "$ref": "#/components/schemas/cyclonedx.Lifecycle" }, "type": "array", "uniqueItems": false }, "manufacture": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity", "description": "Deprecated: Use Component Manufacturer instead." }, "manufacturer": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "supplier": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "timestamp": { "type": "string" }, "tools": { "$ref": "#/components/schemas/cyclonedx.ToolsChoice" } }, "required": [ "authors", "component", "distributionConstraints", "licenses", "lifecycles", "manufacture", "manufacturer", "properties", "supplier", "timestamp", "tools" ], "type": "object" }, "cyclonedx.Note": { "properties": { "locale": { "type": "string" }, "text": { "$ref": "#/components/schemas/cyclonedx.AttachedText" } }, "required": [ "locale", "text" ], "type": "object" }, "cyclonedx.OrganizationalContact": { "properties": { "bom-ref": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "bom-ref", "email", "name", "phone" ], "type": "object" }, "cyclonedx.OrganizationalEntity": { "properties": { "address": { "$ref": "#/components/schemas/cyclonedx.PostalAddress" }, "bom-ref": { "type": "string" }, "contact": { "items": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "url": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "address", "bom-ref", "contact", "name", "url" ], "type": "object" }, "cyclonedx.OrganizationalEntityOrContact": { "properties": { "individual": { "$ref": "#/components/schemas/cyclonedx.OrganizationalContact" }, "organization": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" } }, "required": [ "individual", "organization" ], "type": "object" }, "cyclonedx.Parameter": { "properties": { "dataType": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "dataType", "name", "value" ], "type": "object" }, "cyclonedx.Patch": { "properties": { "diff": { "$ref": "#/components/schemas/cyclonedx.Diff" }, "resolves": { "items": { "$ref": "#/components/schemas/cyclonedx.Issue" }, "type": "array", "uniqueItems": false }, "type": { "$ref": "#/components/schemas/cyclonedx.PatchType" } }, "required": [ "diff", "resolves", "type" ], "type": "object" }, "cyclonedx.PatchType": { "enum": [ "backport", "cherry-pick", "monkey", "unofficial" ], "type": "string", "x-enum-varnames": [ "PatchTypeBackport", "PatchTypeCherryPick", "PatchTypeMonkey", "PatchTypeUnofficial" ] }, "cyclonedx.PatentAssertion": { "properties": { "asserter": { "$ref": "#/components/schemas/cyclonedx.AsserterChoice" }, "assertionType": { "$ref": "#/components/schemas/cyclonedx.PatentAssertionType" }, "bom-ref": { "type": "string" }, "notes": { "type": "string" }, "patentRefs": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "asserter", "assertionType", "bom-ref", "notes", "patentRefs" ], "type": "object" }, "cyclonedx.PatentAssertionType": { "enum": [ "ownership", "license", "third-party-claim", "standards-inclusion", "prior-art", "exclusive-rights", "non-assertion", "research-or-evaluation" ], "type": "string", "x-enum-varnames": [ "PatentAssertionTypeOwnership", "PatentAssertionTypeLicense", "PatentAssertionTypeThirdPartyClaim", "PatentAssertionTypeStandardsInclusion", "PatentAssertionTypePriorArt", "PatentAssertionTypeExclusiveRights", "PatentAssertionTypeNonAssertion", "PatentAssertionTypeResearchOrEvaluation" ] }, "cyclonedx.PatentChoice": { "type": "object" }, "cyclonedx.Pedigree": { "properties": { "ancestors": { "items": { "$ref": "#/components/schemas/cyclonedx.Component" }, "type": "array", "uniqueItems": false }, "commits": { "items": { "$ref": "#/components/schemas/cyclonedx.Commit" }, "type": "array", "uniqueItems": false }, "descendants": { "items": { "$ref": "#/components/schemas/cyclonedx.Component" }, "type": "array", "uniqueItems": false }, "notes": { "type": "string" }, "patches": { "items": { "$ref": "#/components/schemas/cyclonedx.Patch" }, "type": "array", "uniqueItems": false }, "variants": { "items": { "$ref": "#/components/schemas/cyclonedx.Component" }, "type": "array", "uniqueItems": false } }, "required": [ "ancestors", "commits", "descendants", "notes", "patches", "variants" ], "type": "object" }, "cyclonedx.PostalAddress": { "properties": { "bom-ref": { "type": "string" }, "country": { "type": "string" }, "locality": { "type": "string" }, "postOfficeBoxNumber": { "type": "string" }, "postalCode": { "type": "string" }, "region": { "type": "string" }, "streetAddress": { "type": "string" } }, "required": [ "bom-ref", "country", "locality", "postOfficeBoxNumber", "postalCode", "region", "streetAddress" ], "type": "object" }, "cyclonedx.ProofOfConcept": { "properties": { "environment": { "type": "string" }, "reproductionSteps": { "type": "string" }, "supportingMaterial": { "items": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "type": "array", "uniqueItems": false } }, "required": [ "environment", "reproductionSteps", "supportingMaterial" ], "type": "object" }, "cyclonedx.Property": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "cyclonedx.RelatedCryptoMaterialProperties": { "properties": { "activationDate": { "type": "string" }, "algorithmRef": { "description": "Deprecated in 1.7: use RelatedCryptographicAssets", "type": "string" }, "creationDate": { "type": "string" }, "expirationDate": { "type": "string" }, "fingerprint": { "$ref": "#/components/schemas/cyclonedx.Hash", "description": "New in 1.7" }, "format": { "type": "string" }, "id": { "type": "string" }, "relatedCryptographicAssets": { "description": "New in 1.7", "items": { "$ref": "#/components/schemas/cyclonedx.RelatedCryptographicAsset" }, "type": "array", "uniqueItems": false }, "securedBy": { "$ref": "#/components/schemas/cyclonedx.SecuredBy" }, "size": { "type": "integer" }, "state": { "$ref": "#/components/schemas/cyclonedx.CryptoKeyState" }, "type": { "$ref": "#/components/schemas/cyclonedx.RelatedCryptoMaterialType" }, "updateDate": { "type": "string" }, "value": { "type": "string" } }, "required": [ "activationDate", "algorithmRef", "creationDate", "expirationDate", "fingerprint", "format", "id", "relatedCryptographicAssets", "securedBy", "size", "state", "type", "updateDate", "value" ], "type": "object" }, "cyclonedx.RelatedCryptoMaterialType": { "enum": [ "private-key", "public-key", "secret-key", "key", "ciphertext", "signature", "digest", "initialization-vector", "nonce", "seed", "salt", "shared-secret", "tag", "additional-data", "password", "credential", "token", "other", "unknown" ], "type": "string", "x-enum-varnames": [ "RelatedCryptoMaterialTypePrivateKey", "RelatedCryptoMaterialTypePublicKey", "RelatedCryptoMaterialTypeSecretKey", "RelatedCryptoMaterialTypeKey", "RelatedCryptoMaterialTypeCiphertext", "RelatedCryptoMaterialTypeSignature", "RelatedCryptoMaterialTypeDigest", "RelatedCryptoMaterialTypeInitializationVector", "RelatedCryptoMaterialTypeNonce", "RelatedCryptoMaterialTypeSeed", "RelatedCryptoMaterialTypeSalt", "RelatedCryptoMaterialTypeSharedSecret", "RelatedCryptoMaterialTypeTag", "RelatedCryptoMaterialTypeAdditionalData", "RelatedCryptoMaterialTypePassword", "RelatedCryptoMaterialTypeCredential", "RelatedCryptoMaterialTypeToken", "RelatedCryptoMaterialTypeOther", "RelatedCryptoMaterialTypeUnknown" ] }, "cyclonedx.RelatedCryptographicAsset": { "properties": { "ref": { "type": "string" }, "type": { "type": "string" } }, "required": [ "ref", "type" ], "type": "object" }, "cyclonedx.ReleaseNotes": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" }, "featuredImage": { "type": "string" }, "notes": { "items": { "$ref": "#/components/schemas/cyclonedx.Note" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "resolves": { "items": { "$ref": "#/components/schemas/cyclonedx.Issue" }, "type": "array", "uniqueItems": false }, "socialImage": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "timestamp": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "aliases", "description", "featuredImage", "notes", "properties", "resolves", "socialImage", "tags", "timestamp", "title", "type" ], "type": "object" }, "cyclonedx.ResourceReferenceChoice": { "properties": { "externalReference": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "ref": { "type": "string" } }, "required": [ "externalReference", "ref" ], "type": "object" }, "cyclonedx.SWID": { "properties": { "name": { "type": "string" }, "patch": { "type": "boolean" }, "tagId": { "type": "string" }, "tagVersion": { "type": "integer" }, "text": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "url": { "type": "string" }, "version": { "type": "string" } }, "required": [ "name", "patch", "tagId", "tagVersion", "text", "url", "version" ], "type": "object" }, "cyclonedx.Scope": { "enum": [ "excluded", "optional", "required" ], "type": "string", "x-enum-varnames": [ "ScopeExcluded", "ScopeOptional", "ScopeRequired" ] }, "cyclonedx.ScoringMethod": { "enum": [ "other", "CVSSv2", "CVSSv3", "CVSSv31", "CVSSv4", "OWASP", "SSVC" ], "type": "string", "x-enum-varnames": [ "ScoringMethodOther", "ScoringMethodCVSSv2", "ScoringMethodCVSSv3", "ScoringMethodCVSSv31", "ScoringMethodCVSSv4", "ScoringMethodOWASP", "ScoringMethodSSVC" ] }, "cyclonedx.SecuredBy": { "properties": { "algorithmRef": { "type": "string" }, "mechanism": { "type": "string" } }, "required": [ "algorithmRef", "mechanism" ], "type": "object" }, "cyclonedx.Service": { "properties": { "authenticated": { "type": "boolean" }, "bom-ref": { "type": "string" }, "data": { "items": { "$ref": "#/components/schemas/cyclonedx.DataClassification" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" }, "endpoints": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "externalReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "type": "array", "uniqueItems": false }, "group": { "type": "string" }, "licenses": { "items": { "$ref": "#/components/schemas/cyclonedx.LicenseChoice" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "patentAssertions": { "items": { "$ref": "#/components/schemas/cyclonedx.PatentAssertion" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "provider": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "releaseNotes": { "$ref": "#/components/schemas/cyclonedx.ReleaseNotes" }, "services": { "items": { "$ref": "#/components/schemas/cyclonedx.Service" }, "type": "array", "uniqueItems": false }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "tags": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "trustZone": { "type": "string" }, "version": { "type": "string" }, "x-trust-boundary": { "type": "boolean" } }, "required": [ "authenticated", "bom-ref", "data", "description", "endpoints", "externalReferences", "group", "licenses", "name", "patentAssertions", "properties", "provider", "releaseNotes", "services", "signature", "tags", "trustZone", "version", "x-trust-boundary" ], "type": "object" }, "cyclonedx.Severity": { "enum": [ "unknown", "none", "info", "low", "medium", "high", "critical" ], "type": "string", "x-enum-varnames": [ "SeverityUnknown", "SeverityNone", "SeverityInfo", "SeverityLow", "SeverityMedium", "SeverityHigh", "SeverityCritical" ] }, "cyclonedx.Signatory": { "properties": { "externalReference": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "name": { "type": "string" }, "organization": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "role": { "type": "string" }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" } }, "required": [ "externalReference", "name", "organization", "role", "signature" ], "type": "object" }, "cyclonedx.Source": { "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "cyclonedx.SpecVersion": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "x-enum-comments": { "SpecVersion1_0": "1.0", "SpecVersion1_1": "1.1", "SpecVersion1_2": "1.2", "SpecVersion1_3": "1.3", "SpecVersion1_4": "1.4", "SpecVersion1_5": "1.5", "SpecVersion1_6": "1.6", "SpecVersion1_7": "1.7" }, "x-enum-varnames": [ "SpecVersion1_0", "SpecVersion1_1", "SpecVersion1_2", "SpecVersion1_3", "SpecVersion1_4", "SpecVersion1_5", "SpecVersion1_6", "SpecVersion1_7" ] }, "cyclonedx.StandardDefinition": { "properties": { "bom-ref": { "type": "string" }, "description": { "type": "string" }, "externalReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "type": "array", "uniqueItems": false }, "levels": { "items": { "$ref": "#/components/schemas/cyclonedx.StandardLevel" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "owner": { "type": "string" }, "requirements": { "items": { "$ref": "#/components/schemas/cyclonedx.StandardRequirement" }, "type": "array", "uniqueItems": false }, "signature": { "$ref": "#/components/schemas/cyclonedx.JSFSignature" }, "version": { "type": "string" } }, "required": [ "bom-ref", "description", "externalReferences", "levels", "name", "owner", "requirements", "signature", "version" ], "type": "object" }, "cyclonedx.StandardLevel": { "properties": { "bom-ref": { "type": "string" }, "description": { "type": "string" }, "identifier": { "type": "string" }, "requirements": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "title": { "type": "string" } }, "required": [ "bom-ref", "description", "identifier", "requirements", "title" ], "type": "object" }, "cyclonedx.StandardRequirement": { "properties": { "bom-ref": { "type": "string" }, "descriptions": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "externalReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ExternalReference" }, "type": "array", "uniqueItems": false }, "identifier": { "type": "string" }, "openCre": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "parent": { "type": "string" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "text": { "type": "string" }, "title": { "type": "string" } }, "required": [ "bom-ref", "descriptions", "externalReferences", "identifier", "openCre", "parent", "properties", "text", "title" ], "type": "object" }, "cyclonedx.TLPClassification": { "enum": [ "CLEAR", "GREEN", "AMBER", "AMBER_AND_STRICT", "RED" ], "type": "string", "x-enum-varnames": [ "TLPClassificationClear", "TLPClassificationGreen", "TLPClassificationAmber", "TLPClassificationAmberAndStrict", "TLPClassificationRed" ] }, "cyclonedx.Targets": { "properties": { "components": { "items": { "$ref": "#/components/schemas/cyclonedx.Component" }, "type": "array", "uniqueItems": false }, "organizations": { "items": { "$ref": "#/components/schemas/cyclonedx.OrganizationalEntity" }, "type": "array", "uniqueItems": false }, "services": { "items": { "$ref": "#/components/schemas/cyclonedx.Service" }, "type": "array", "uniqueItems": false } }, "required": [ "components", "organizations", "services" ], "type": "object" }, "cyclonedx.Task": { "properties": { "bom-ref": { "type": "string" }, "description": { "type": "string" }, "inputs": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskInput" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "outputs": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskOutput" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "resourceReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "type": "array", "uniqueItems": false }, "runtimeTopology": { "items": { "$ref": "#/components/schemas/cyclonedx.Dependency" }, "type": "array", "uniqueItems": false }, "steps": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskStep" }, "type": "array", "uniqueItems": false }, "taskTypes": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskType" }, "type": "array", "uniqueItems": false }, "timeEnd": { "type": "string" }, "timeStart": { "type": "string" }, "trigger": { "$ref": "#/components/schemas/cyclonedx.TaskTrigger" }, "uid": { "type": "string" }, "workspaces": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskWorkspace" }, "type": "array", "uniqueItems": false } }, "required": [ "bom-ref", "description", "inputs", "name", "outputs", "properties", "resourceReferences", "runtimeTopology", "steps", "taskTypes", "timeEnd", "timeStart", "trigger", "uid", "workspaces" ], "type": "object" }, "cyclonedx.TaskCommand": { "properties": { "executed": { "type": "string" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false } }, "required": [ "executed", "properties" ], "type": "object" }, "cyclonedx.TaskInput": { "properties": { "data": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "environmentVars": { "items": { "$ref": "#/components/schemas/cyclonedx.EnvironmentVariableChoice" }, "type": "array", "uniqueItems": false }, "parameters": { "items": { "$ref": "#/components/schemas/cyclonedx.Parameter" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "resource": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "source": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "target": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" } }, "required": [ "data", "environmentVars", "parameters", "properties", "resource", "source", "target" ], "type": "object" }, "cyclonedx.TaskOutput": { "properties": { "data": { "$ref": "#/components/schemas/cyclonedx.AttachedText" }, "environmentVars": { "items": { "$ref": "#/components/schemas/cyclonedx.EnvironmentVariableChoice" }, "type": "array", "uniqueItems": false }, "parameters": { "items": { "$ref": "#/components/schemas/cyclonedx.Parameter" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "resource": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "source": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "target": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "type": { "$ref": "#/components/schemas/cyclonedx.TaskOutputType" } }, "required": [ "data", "environmentVars", "parameters", "properties", "resource", "source", "target", "type" ], "type": "object" }, "cyclonedx.TaskOutputType": { "enum": [ "artifact", "attestation", "evidence", "log", "metrics", "other" ], "type": "string", "x-enum-varnames": [ "TaskOutputTypeArtifact", "TaskOutputTypeAttestation", "TaskOutputTypeEvidence", "TaskOutputTypeLog", "TaskOutputTypeMetrics", "TaskOutputTypeOther" ] }, "cyclonedx.TaskStep": { "properties": { "commands": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskCommand" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" }, "name": { "type": "string" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false } }, "required": [ "commands", "description", "name", "properties" ], "type": "object" }, "cyclonedx.TaskTrigger": { "properties": { "bom-ref": { "type": "string" }, "conditions": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskTriggerCondition" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" }, "event": { "$ref": "#/components/schemas/cyclonedx.Event" }, "inputs": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskInput" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "outputs": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskOutput" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "resourceReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "type": "array", "uniqueItems": false }, "timeActivated": { "type": "string" }, "type": { "$ref": "#/components/schemas/cyclonedx.TaskTriggerType" }, "uid": { "type": "string" } }, "required": [ "bom-ref", "conditions", "description", "event", "inputs", "name", "outputs", "properties", "resourceReferences", "timeActivated", "type", "uid" ], "type": "object" }, "cyclonedx.TaskTriggerCondition": { "properties": { "description": { "type": "string" }, "expression": { "type": "string" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false } }, "required": [ "description", "expression", "properties" ], "type": "object" }, "cyclonedx.TaskTriggerType": { "enum": [ "api", "manual", "scheduled", "webhook" ], "type": "string", "x-enum-varnames": [ "TaskTriggerTypeAPI", "TaskTriggerTypeManual", "TaskTriggerTypeScheduled", "TaskTriggerTypeWebhook" ] }, "cyclonedx.TaskType": { "enum": [ "build", "clean", "clone", "copy", "deliver", "deploy", "lint", "merge", "other", "release", "scan", "test" ], "type": "string", "x-enum-varnames": [ "TaskTypeBuild", "TaskTypeClean", "TaskTypeClone", "TaskTypeCopy", "TaskTypeDeliver", "TaskTypeDeploy", "TaskTypeLint", "TaskTypeMerge", "TaskTypeOther", "TaskTypeRelease", "TaskTypeScan", "TaskTypeTest" ] }, "cyclonedx.TaskWorkspace": { "properties": { "accessMode": { "$ref": "#/components/schemas/cyclonedx.TaskWorkspaceAccessMode" }, "aliases": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "bom-ref": { "type": "string" }, "description": { "type": "string" }, "managedDataType": { "type": "string" }, "mountPath": { "type": "string" }, "name": { "type": "string" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "resourceReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "type": "array", "uniqueItems": false }, "uid": { "type": "string" }, "volume": { "$ref": "#/components/schemas/cyclonedx.Volume" }, "volumeRequest": { "type": "string" } }, "required": [ "accessMode", "aliases", "bom-ref", "description", "managedDataType", "mountPath", "name", "properties", "resourceReferences", "uid", "volume", "volumeRequest" ], "type": "object" }, "cyclonedx.TaskWorkspaceAccessMode": { "enum": [ "read-only", "read-write", "read-write-once", "write-once", "write-only" ], "type": "string", "x-enum-varnames": [ "TaskWorkspaceAccessModeReadOnly", "TaskWorkspaceAccessModeReadWrite", "TaskWorkspaceAccessModeReadWriteOnce", "TaskWorkspaceAccessModeWriteOnce", "TaskWorkspaceAccessModeWriteOnly" ] }, "cyclonedx.ToolsChoice": { "type": "object" }, "cyclonedx.Volume": { "properties": { "mode": { "$ref": "#/components/schemas/cyclonedx.VolumeMode" }, "name": { "type": "string" }, "path": { "type": "string" }, "persistent": { "type": "boolean" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "remote": { "type": "boolean" }, "sizeAllocated": { "type": "string" }, "uid": { "type": "string" } }, "required": [ "mode", "name", "path", "persistent", "properties", "remote", "sizeAllocated", "uid" ], "type": "object" }, "cyclonedx.VolumeMode": { "enum": [ "block", "file-system" ], "type": "string", "x-enum-varnames": [ "VolumeModeBlock", "VolumeModeFilesystem" ] }, "cyclonedx.Vulnerability": { "properties": { "advisories": { "items": { "$ref": "#/components/schemas/cyclonedx.Advisory" }, "type": "array", "uniqueItems": false }, "affects": { "items": { "$ref": "#/components/schemas/cyclonedx.Affects" }, "type": "array", "uniqueItems": false }, "analysis": { "$ref": "#/components/schemas/cyclonedx.VulnerabilityAnalysis" }, "bom-ref": { "type": "string" }, "created": { "type": "string" }, "credits": { "$ref": "#/components/schemas/cyclonedx.Credits" }, "cwes": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false }, "description": { "type": "string" }, "detail": { "type": "string" }, "id": { "type": "string" }, "proofOfConcept": { "$ref": "#/components/schemas/cyclonedx.ProofOfConcept" }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "published": { "type": "string" }, "ratings": { "items": { "$ref": "#/components/schemas/cyclonedx.VulnerabilityRating" }, "type": "array", "uniqueItems": false }, "recommendation": { "type": "string" }, "references": { "items": { "$ref": "#/components/schemas/cyclonedx.VulnerabilityReference" }, "type": "array", "uniqueItems": false }, "rejected": { "type": "string" }, "source": { "$ref": "#/components/schemas/cyclonedx.Source" }, "tools": { "$ref": "#/components/schemas/cyclonedx.ToolsChoice" }, "updated": { "type": "string" }, "workaround": { "type": "string" } }, "required": [ "advisories", "affects", "analysis", "bom-ref", "created", "credits", "cwes", "description", "detail", "id", "proofOfConcept", "properties", "published", "ratings", "recommendation", "references", "rejected", "source", "tools", "updated", "workaround" ], "type": "object" }, "cyclonedx.VulnerabilityAnalysis": { "properties": { "detail": { "type": "string" }, "firstIssued": { "type": "string" }, "justification": { "$ref": "#/components/schemas/cyclonedx.ImpactAnalysisJustification" }, "lastUpdated": { "type": "string" }, "response": { "items": { "$ref": "#/components/schemas/cyclonedx.ImpactAnalysisResponse" }, "type": "array", "uniqueItems": false }, "state": { "$ref": "#/components/schemas/cyclonedx.ImpactAnalysisState" } }, "required": [ "detail", "firstIssued", "justification", "lastUpdated", "response", "state" ], "type": "object" }, "cyclonedx.VulnerabilityRating": { "properties": { "justification": { "type": "string" }, "method": { "$ref": "#/components/schemas/cyclonedx.ScoringMethod" }, "score": { "type": "number" }, "severity": { "$ref": "#/components/schemas/cyclonedx.Severity" }, "source": { "$ref": "#/components/schemas/cyclonedx.Source" }, "vector": { "type": "string" } }, "required": [ "justification", "method", "score", "severity", "source", "vector" ], "type": "object" }, "cyclonedx.VulnerabilityReference": { "properties": { "id": { "type": "string" }, "source": { "$ref": "#/components/schemas/cyclonedx.Source" } }, "required": [ "id", "source" ], "type": "object" }, "cyclonedx.VulnerabilityStatus": { "enum": [ "unknown", "affected", "unaffected" ], "type": "string", "x-enum-varnames": [ "VulnerabilityStatusUnknown", "VulnerabilityStatusAffected", "VulnerabilityStatusNotAffected" ] }, "cyclonedx.Workflow": { "properties": { "bom-ref": { "type": "string" }, "description": { "type": "string" }, "inputs": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskInput" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "outputs": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskOutput" }, "type": "array", "uniqueItems": false }, "properties": { "items": { "$ref": "#/components/schemas/cyclonedx.Property" }, "type": "array", "uniqueItems": false }, "resourceReferences": { "items": { "$ref": "#/components/schemas/cyclonedx.ResourceReferenceChoice" }, "type": "array", "uniqueItems": false }, "runtimeTopology": { "items": { "$ref": "#/components/schemas/cyclonedx.Dependency" }, "type": "array", "uniqueItems": false }, "steps": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskStep" }, "type": "array", "uniqueItems": false }, "taskDependencies": { "items": { "$ref": "#/components/schemas/cyclonedx.Dependency" }, "type": "array", "uniqueItems": false }, "taskTypes": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskType" }, "type": "array", "uniqueItems": false }, "tasks": { "items": { "$ref": "#/components/schemas/cyclonedx.Task" }, "type": "array", "uniqueItems": false }, "timeEnd": { "type": "string" }, "timeStart": { "type": "string" }, "trigger": { "$ref": "#/components/schemas/cyclonedx.TaskTrigger" }, "uid": { "type": "string" }, "workspaces": { "items": { "$ref": "#/components/schemas/cyclonedx.TaskWorkspace" }, "type": "array", "uniqueItems": false } }, "required": [ "bom-ref", "description", "inputs", "name", "outputs", "properties", "resourceReferences", "runtimeTopology", "steps", "taskDependencies", "taskTypes", "tasks", "timeEnd", "timeStart", "trigger", "uid", "workspaces" ], "type": "object" }, "dtos.AcceptInvitationRequest": { "properties": { "code": { "type": "string" } }, "required": [ "code" ], "type": "object" }, "dtos.AdminsInOrg": { "properties": { "admins": { "items": { "$ref": "#/components/schemas/dtos.UserDTO" }, "type": "array", "uniqueItems": false }, "id": { "type": "string" }, "instance_id": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "admins", "id", "instance_id", "slug" ], "type": "object" }, "dtos.AdvisoryCreate": { "properties": { "affectedPackages": { "items": { "$ref": "#/components/schemas/dtos.AffectedPackage" }, "type": "array", "uniqueItems": false }, "assetID": { "type": "string" }, "description": { "type": "string" }, "severity": { "type": "string" }, "title": { "type": "string" }, "vectorString": { "type": "string" } }, "required": [ "affectedPackages", "assetID", "description", "severity", "title", "vectorString" ], "type": "object" }, "dtos.AdvisoryUpdate": { "properties": { "affectedPackages": { "items": { "$ref": "#/components/schemas/dtos.AffectedPackage" }, "type": "array", "uniqueItems": false }, "assetID": { "type": "string" }, "description": { "type": "string" }, "severity": { "type": "string" }, "title": { "type": "string" }, "vectorString": { "type": "string" } }, "required": [ "affectedPackages", "assetID", "description", "severity", "title", "vectorString" ], "type": "object" }, "dtos.Affected": { "properties": { "ecosystem_specific": { "$ref": "#/components/schemas/dtos.EcosystemSpecific" }, "package": { "$ref": "#/components/schemas/dtos.Package" }, "ranges": { "items": { "$ref": "#/components/schemas/dtos.Range" }, "type": "array", "uniqueItems": false }, "versions": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "ecosystem_specific", "package", "ranges", "versions" ], "type": "object" }, "dtos.AffectedComponentDTO": { "properties": { "cves": { "items": { "$ref": "#/components/schemas/dtos.CVEDTO" }, "type": "array", "uniqueItems": false }, "ecosystem": { "type": "string" }, "id": { "type": "integer" }, "purl": { "type": "string" }, "semverEnd": { "type": "string" }, "semverStart": { "type": "string" }, "version": { "type": "string" }, "versionFixed": { "type": "string" }, "versionIntroduced": { "type": "string" } }, "required": [ "cves", "ecosystem", "id", "purl", "semverEnd", "semverStart", "version", "versionFixed", "versionIntroduced" ], "type": "object" }, "dtos.AffectedPackage": { "properties": { "ecosystem": { "type": "string" }, "id": { "type": "string" }, "packageName": { "type": "string" }, "versionEnd": { "type": "string" }, "versionStart": { "type": "string" } }, "required": [ "ecosystem", "id", "packageName", "versionEnd", "versionStart" ], "type": "object" }, "dtos.ArtifactDTO": { "properties": { "artifactName": { "type": "string" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" } }, "required": [ "artifactName", "assetId", "assetVersionName" ], "type": "object" }, "dtos.ArtifactVulnDistribution": { "properties": { "assetSlug": { "type": "string" }, "assetVersionName": { "type": "string" }, "critical": { "type": "integer" }, "criticalCvss": { "type": "integer" }, "high": { "type": "integer" }, "highCvss": { "type": "integer" }, "low": { "type": "integer" }, "lowCvss": { "type": "integer" }, "medium": { "type": "integer" }, "mediumCvss": { "type": "integer" }, "name": { "type": "string" }, "projectSlug": { "type": "string" } }, "required": [ "assetSlug", "assetVersionName", "critical", "criticalCvss", "high", "highCvss", "low", "lowCvss", "medium", "mediumCvss", "name", "projectSlug" ], "type": "object" }, "dtos.AssetChangeRoleRequest": { "properties": { "role": { "enum": [ "member", "admin" ], "type": "string" } }, "required": [ "role" ], "type": "object" }, "dtos.AssetCreateRequest": { "properties": { "availabilityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "centralDependencyVulnManagement": { "type": "boolean" }, "confidentialityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "cvssAutomaticTicketThreshold": { "type": "number" }, "description": { "type": "string" }, "enableTicketRange": { "type": "boolean" }, "importance": { "type": "integer" }, "integrityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "modifiedAttackComplexity": { "$ref": "#/components/schemas/dtos.ModifiedAttackComplexity" }, "modifiedAttackVector": { "$ref": "#/components/schemas/dtos.ModifiedAttackVector" }, "modifiedAvailability": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedConfidentiality": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedIntegrity": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedPrivilegesRequired": { "$ref": "#/components/schemas/dtos.ModifiedPrivilegesRequired" }, "modifiedScope": { "$ref": "#/components/schemas/dtos.ModifiedScope" }, "modifiedUserInteraction": { "$ref": "#/components/schemas/dtos.ModifiedUserInteraction" }, "name": { "type": "string" }, "repositoryProvider": { "description": "either null or github or gitlab, etc.", "enum": [ "github", "gitlab" ], "type": "string" }, "riskAutomaticTicketThreshold": { "type": "number" } }, "required": [ "availabilityRequirement", "centralDependencyVulnManagement", "confidentialityRequirement", "cvssAutomaticTicketThreshold", "description", "enableTicketRange", "importance", "integrityRequirement", "modifiedAttackComplexity", "modifiedAttackVector", "modifiedAvailability", "modifiedConfidentiality", "modifiedIntegrity", "modifiedPrivilegesRequired", "modifiedScope", "modifiedUserInteraction", "name", "repositoryProvider", "riskAutomaticTicketThreshold" ], "type": "object" }, "dtos.AssetDTO": { "properties": { "availabilityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "avatar": { "type": "string" }, "centralDependencyVulnManagement": { "type": "boolean" }, "confidentialityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "cvssAutomaticTicketThreshold": { "type": "number" }, "description": { "type": "string" }, "enableTicketRange": { "type": "boolean" }, "externalBotUserLink": { "type": "string" }, "externalEntityId": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "id": { "type": "string" }, "integrityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "isPublic": { "type": "boolean" }, "modifiedAttackComplexity": { "$ref": "#/components/schemas/dtos.ModifiedAttackComplexity" }, "modifiedAttackVector": { "$ref": "#/components/schemas/dtos.ModifiedAttackVector" }, "modifiedAvailability": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedConfidentiality": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedIntegrity": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedPrivilegesRequired": { "$ref": "#/components/schemas/dtos.ModifiedPrivilegesRequired" }, "modifiedScope": { "$ref": "#/components/schemas/dtos.ModifiedScope" }, "modifiedUserInteraction": { "$ref": "#/components/schemas/dtos.ModifiedUserInteraction" }, "name": { "type": "string" }, "paranoidMode": { "type": "boolean" }, "pipelineLastRun": { "type": "string" }, "projectId": { "type": "string" }, "refs": { "items": { "$ref": "#/components/schemas/dtos.AssetVersionDTO" }, "type": "array", "uniqueItems": false }, "repositoryId": { "type": "string" }, "repositoryName": { "type": "string" }, "repositoryProvider": { "type": "string" }, "riskAutomaticTicketThreshold": { "type": "number" }, "sharesInformation": { "type": "boolean" }, "signingPubKey": { "type": "string" }, "slug": { "type": "string" }, "state": { "type": "string" }, "vulnAutoReopenAfterDays": { "type": "integer" } }, "required": [ "availabilityRequirement", "avatar", "centralDependencyVulnManagement", "confidentialityRequirement", "cvssAutomaticTicketThreshold", "description", "enableTicketRange", "externalBotUserLink", "externalEntityId", "externalEntityProviderId", "id", "integrityRequirement", "isPublic", "modifiedAttackComplexity", "modifiedAttackVector", "modifiedAvailability", "modifiedConfidentiality", "modifiedIntegrity", "modifiedPrivilegesRequired", "modifiedScope", "modifiedUserInteraction", "name", "paranoidMode", "pipelineLastRun", "projectId", "refs", "repositoryId", "repositoryName", "repositoryProvider", "riskAutomaticTicketThreshold", "sharesInformation", "signingPubKey", "slug", "state", "vulnAutoReopenAfterDays" ], "type": "object" }, "dtos.AssetDetailsDTO": { "properties": { "availabilityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "avatar": { "type": "string" }, "centralDependencyVulnManagement": { "type": "boolean" }, "confidentialityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "cvssAutomaticTicketThreshold": { "type": "number" }, "description": { "type": "string" }, "enableTicketRange": { "type": "boolean" }, "externalBotUserLink": { "type": "string" }, "externalEntityId": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "id": { "type": "string" }, "integrityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "isPublic": { "type": "boolean" }, "members": { "items": { "$ref": "#/components/schemas/dtos.UserDTO" }, "type": "array", "uniqueItems": false }, "modifiedAttackComplexity": { "$ref": "#/components/schemas/dtos.ModifiedAttackComplexity" }, "modifiedAttackVector": { "$ref": "#/components/schemas/dtos.ModifiedAttackVector" }, "modifiedAvailability": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedConfidentiality": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedIntegrity": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedPrivilegesRequired": { "$ref": "#/components/schemas/dtos.ModifiedPrivilegesRequired" }, "modifiedScope": { "$ref": "#/components/schemas/dtos.ModifiedScope" }, "modifiedUserInteraction": { "$ref": "#/components/schemas/dtos.ModifiedUserInteraction" }, "name": { "type": "string" }, "paranoidMode": { "type": "boolean" }, "pipelineLastRun": { "type": "string" }, "projectId": { "type": "string" }, "refs": { "items": { "$ref": "#/components/schemas/dtos.AssetVersionDTO" }, "type": "array", "uniqueItems": false }, "repositoryId": { "type": "string" }, "repositoryName": { "type": "string" }, "repositoryProvider": { "type": "string" }, "riskAutomaticTicketThreshold": { "type": "number" }, "sharesInformation": { "type": "boolean" }, "signingPubKey": { "type": "string" }, "slug": { "type": "string" }, "state": { "type": "string" }, "vulnAutoReopenAfterDays": { "type": "integer" } }, "required": [ "availabilityRequirement", "avatar", "centralDependencyVulnManagement", "confidentialityRequirement", "cvssAutomaticTicketThreshold", "description", "enableTicketRange", "externalBotUserLink", "externalEntityId", "externalEntityProviderId", "id", "integrityRequirement", "isPublic", "members", "modifiedAttackComplexity", "modifiedAttackVector", "modifiedAvailability", "modifiedConfidentiality", "modifiedIntegrity", "modifiedPrivilegesRequired", "modifiedScope", "modifiedUserInteraction", "name", "paranoidMode", "pipelineLastRun", "projectId", "refs", "repositoryId", "repositoryName", "repositoryProvider", "riskAutomaticTicketThreshold", "sharesInformation", "signingPubKey", "slug", "state", "vulnAutoReopenAfterDays" ], "type": "object" }, "dtos.AssetDetailsWithSecretsDTO": { "properties": { "availabilityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "avatar": { "type": "string" }, "centralDependencyVulnManagement": { "type": "boolean" }, "confidentialityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "cvssAutomaticTicketThreshold": { "type": "number" }, "description": { "type": "string" }, "enableTicketRange": { "type": "boolean" }, "externalBotUserLink": { "type": "string" }, "externalEntityId": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "id": { "type": "string" }, "integrityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "isPublic": { "type": "boolean" }, "members": { "items": { "$ref": "#/components/schemas/dtos.UserDTO" }, "type": "array", "uniqueItems": false }, "modifiedAttackComplexity": { "$ref": "#/components/schemas/dtos.ModifiedAttackComplexity" }, "modifiedAttackVector": { "$ref": "#/components/schemas/dtos.ModifiedAttackVector" }, "modifiedAvailability": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedConfidentiality": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedIntegrity": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedPrivilegesRequired": { "$ref": "#/components/schemas/dtos.ModifiedPrivilegesRequired" }, "modifiedScope": { "$ref": "#/components/schemas/dtos.ModifiedScope" }, "modifiedUserInteraction": { "$ref": "#/components/schemas/dtos.ModifiedUserInteraction" }, "name": { "type": "string" }, "paranoidMode": { "type": "boolean" }, "pipelineLastRun": { "type": "string" }, "projectId": { "type": "string" }, "refs": { "items": { "$ref": "#/components/schemas/dtos.AssetVersionDTO" }, "type": "array", "uniqueItems": false }, "repositoryId": { "type": "string" }, "repositoryName": { "type": "string" }, "repositoryProvider": { "type": "string" }, "riskAutomaticTicketThreshold": { "type": "number" }, "sharesInformation": { "type": "boolean" }, "signingPubKey": { "type": "string" }, "slug": { "type": "string" }, "state": { "type": "string" }, "vulnAutoReopenAfterDays": { "type": "integer" }, "webhookSecret": { "type": "string" } }, "required": [ "availabilityRequirement", "avatar", "centralDependencyVulnManagement", "confidentialityRequirement", "cvssAutomaticTicketThreshold", "description", "enableTicketRange", "externalBotUserLink", "externalEntityId", "externalEntityProviderId", "id", "integrityRequirement", "isPublic", "members", "modifiedAttackComplexity", "modifiedAttackVector", "modifiedAvailability", "modifiedConfidentiality", "modifiedIntegrity", "modifiedPrivilegesRequired", "modifiedScope", "modifiedUserInteraction", "name", "paranoidMode", "pipelineLastRun", "projectId", "refs", "repositoryId", "repositoryName", "repositoryProvider", "riskAutomaticTicketThreshold", "sharesInformation", "signingPubKey", "slug", "state", "vulnAutoReopenAfterDays", "webhookSecret" ], "type": "object" }, "dtos.AssetEntryDTO": { "properties": { "assetExternalEntityId": { "type": "string" }, "assetName": { "type": "string" }, "assetVersions": { "items": { "$ref": "#/components/schemas/dtos.AssetVersionEntryDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "assetExternalEntityId", "assetName", "assetVersions" ], "type": "object" }, "dtos.AssetInviteToAssetRequest": { "properties": { "ids": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "ids" ], "type": "object" }, "dtos.AssetPatchRequest": { "properties": { "availabilityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "centralDependencyVulnManagement": { "type": "boolean" }, "confidentialityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "configFiles": { "additionalProperties": {}, "type": "object" }, "cvssAutomaticTicketThreshold": { "type": "number" }, "description": { "type": "string" }, "enableTicketRange": { "type": "boolean" }, "integrityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "isPublic": { "type": "boolean" }, "modifiedAttackComplexity": { "$ref": "#/components/schemas/dtos.ModifiedAttackComplexity" }, "modifiedAttackVector": { "$ref": "#/components/schemas/dtos.ModifiedAttackVector" }, "modifiedAvailability": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedConfidentiality": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedIntegrity": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedPrivilegesRequired": { "$ref": "#/components/schemas/dtos.ModifiedPrivilegesRequired" }, "modifiedScope": { "$ref": "#/components/schemas/dtos.ModifiedScope" }, "modifiedUserInteraction": { "$ref": "#/components/schemas/dtos.ModifiedUserInteraction" }, "name": { "type": "string" }, "paranoidMode": { "type": "boolean" }, "repositoryId": { "type": "string" }, "repositoryName": { "type": "string" }, "repositoryProvider": { "description": "either null or github or gitlab, etc.", "enum": [ "github", "gitlab" ], "type": "string" }, "riskAutomaticTicketThreshold": { "type": "number" }, "sharesInformation": { "type": "boolean" }, "vulnAutoReopenAfterDays": { "type": "integer" }, "webhookSecret": { "type": "string" } }, "required": [ "availabilityRequirement", "centralDependencyVulnManagement", "confidentialityRequirement", "configFiles", "cvssAutomaticTicketThreshold", "description", "enableTicketRange", "integrityRequirement", "isPublic", "modifiedAttackComplexity", "modifiedAttackVector", "modifiedAvailability", "modifiedConfidentiality", "modifiedIntegrity", "modifiedPrivilegesRequired", "modifiedScope", "modifiedUserInteraction", "name", "paranoidMode", "repositoryId", "repositoryName", "repositoryProvider", "riskAutomaticTicketThreshold", "sharesInformation", "vulnAutoReopenAfterDays", "webhookSecret" ], "type": "object" }, "dtos.AssetVersionDTO": { "properties": { "assetId": { "type": "string" }, "createdAt": { "type": "string" }, "defaultBranch": { "type": "boolean" }, "lastAccessedAt": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "signingPubKey": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "assetId", "createdAt", "defaultBranch", "lastAccessedAt", "metadata", "name", "signingPubKey", "slug", "type", "updatedAt" ], "type": "object" }, "dtos.AssetVersionEntryDTO": { "properties": { "artifacts": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "assetVersionName": { "type": "string" } }, "required": [ "artifacts", "assetVersionName" ], "type": "object" }, "dtos.AssetVulnDistribution": { "properties": { "critical": { "type": "integer" }, "criticalCvss": { "type": "integer" }, "high": { "type": "integer" }, "highCvss": { "type": "integer" }, "low": { "type": "integer" }, "lowCvss": { "type": "integer" }, "medium": { "type": "integer" }, "mediumCvss": { "type": "integer" }, "name": { "type": "string" }, "projectSlug": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "critical", "criticalCvss", "high", "highCvss", "low", "lowCvss", "medium", "mediumCvss", "name", "projectSlug", "slug" ], "type": "object" }, "dtos.AverageRemediationTimes": { "properties": { "criticalCVSSOpen": { "type": "number" }, "criticalCVSSRemediated": { "type": "number" }, "criticalRiskOpen": { "type": "number" }, "criticalRiskRemediated": { "type": "number" }, "highCVSSOpen": { "type": "number" }, "highCVSSRemediated": { "type": "number" }, "highRiskOpen": { "type": "number" }, "highRiskRemediated": { "type": "number" }, "lowCVSSOpen": { "type": "number" }, "lowCVSSRemediated": { "type": "number" }, "lowRiskOpen": { "description": "average age of non remediated (open) vulns", "type": "number" }, "lowRiskRemediated": { "description": "average time until vulns are remediated", "type": "number" }, "mediumCVSSOpen": { "type": "number" }, "mediumCVSSRemediated": { "type": "number" }, "mediumRiskOpen": { "type": "number" }, "mediumRiskRemediated": { "type": "number" } }, "required": [ "criticalCVSSOpen", "criticalCVSSRemediated", "criticalRiskOpen", "criticalRiskRemediated", "highCVSSOpen", "highCVSSRemediated", "highRiskOpen", "highRiskRemediated", "lowCVSSOpen", "lowCVSSRemediated", "lowRiskOpen", "lowRiskRemediated", "mediumCVSSOpen", "mediumCVSSRemediated", "mediumRiskOpen", "mediumRiskRemediated" ], "type": "object" }, "dtos.AverageVulnEventsPerWeek": { "properties": { "averageAcceptedEvents": { "type": "number" }, "averageDetectedEvents": { "type": "number" }, "averageFalsePositiveEvents": { "type": "number" }, "averageFixedEvents": { "type": "number" }, "averageReopenedEvents": { "type": "number" } }, "required": [ "averageAcceptedEvents", "averageDetectedEvents", "averageFalsePositiveEvents", "averageFixedEvents", "averageReopenedEvents" ], "type": "object" }, "dtos.BatchDependencyVulnStatus": { "properties": { "justification": { "maxLength": 4000, "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "status": { "type": "string" }, "vulnIds": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "justification", "mechanicalJustification", "status", "vulnIds" ], "type": "object" }, "dtos.BatchFirstPartyVulnStatus": { "properties": { "justification": { "maxLength": 4000, "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "status": { "type": "string" }, "vulnIds": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "justification", "mechanicalJustification", "status", "vulnIds" ], "type": "object" }, "dtos.BuildInfo": { "properties": { "branch": { "type": "string" }, "buildDate": { "type": "string" }, "commit": { "type": "string" }, "version": { "type": "string" } }, "required": [ "branch", "buildDate", "commit", "version" ], "type": "object" }, "dtos.CVEDTO": { "properties": { "affectedComponents": { "items": { "$ref": "#/components/schemas/dtos.AffectedComponentDTO" }, "type": "array", "uniqueItems": false }, "cisaActionDue": { "format": "date", "type": "string" }, "cisaExploitAdd": { "format": "date", "type": "string" }, "cisaRequiredAction": { "type": "string" }, "cisaVulnerabilityName": { "type": "string" }, "createdAt": { "type": "string" }, "cve": { "type": "string" }, "cvss": { "type": "number" }, "cwes": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "dateLastModified": { "type": "string" }, "datePublished": { "type": "string" }, "description": { "type": "string" }, "epss": { "type": "number" }, "euvdExploitAdd": { "format": "date", "type": "string" }, "exploits": { "items": { "$ref": "#/components/schemas/dtos.ExploitDTO" }, "type": "array", "uniqueItems": false }, "percentile": { "type": "number" }, "references": { "type": "string" }, "relationships": { "items": { "$ref": "#/components/schemas/dtos.RelationshipDTO" }, "type": "array", "uniqueItems": false }, "risk": { "$ref": "#/components/schemas/dtos.RiskMetrics" }, "updatedAt": { "type": "string" }, "vector": { "type": "string" }, "withdrawn": { "type": "string" } }, "required": [ "affectedComponents", "cisaActionDue", "cisaExploitAdd", "cisaRequiredAction", "cisaVulnerabilityName", "createdAt", "cve", "cvss", "cwes", "dateLastModified", "datePublished", "description", "epss", "euvdExploitAdd", "exploits", "percentile", "references", "relationships", "risk", "updatedAt", "vector", "withdrawn" ], "type": "object" }, "dtos.CVEOccurrence": { "properties": { "cveID": { "type": "string" }, "cvss": { "type": "number" }, "totalAmount": { "type": "integer" } }, "required": [ "cveID", "cvss", "totalAmount" ], "type": "object" }, "dtos.CandidatesResponseDTO": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/dtos.ArtifactDTO" }, "type": "array", "uniqueItems": false }, "releases": { "items": { "$ref": "#/components/schemas/dtos.ReleaseDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "artifacts", "releases" ], "type": "object" }, "dtos.ComplianceComponentDetailsDTO": { "properties": { "description": { "type": "string" }, "implementedControls": { "items": { "$ref": "#/components/schemas/dtos.ComplianceComponentImplementsControlDTO" }, "type": "array", "uniqueItems": false }, "title": { "type": "string" }, "uuid": { "type": "string" } }, "required": [ "description", "implementedControls", "title", "uuid" ], "type": "object" }, "dtos.ComplianceComponentImplementsControlDTO": { "properties": { "complianceComponentId": { "type": "string" }, "complianceComponentTitle": { "type": "string" }, "description": { "type": "string" }, "frameworkControlId": { "type": "string" } }, "required": [ "complianceComponentId", "complianceComponentTitle", "description", "frameworkControlId" ], "type": "object" }, "dtos.ComplianceComponentImplementsControlStatementDTO": { "properties": { "complianceComponentDescription": { "type": "string" }, "complianceComponentId": { "type": "string" }, "complianceComponentTitle": { "type": "string" }, "compliancePostureId": { "type": "string" }, "description": { "type": "string" }, "frameworkControlId": { "type": "string" }, "id": { "type": "string" }, "implementationStatus": { "type": "string" } }, "required": [ "complianceComponentDescription", "complianceComponentId", "complianceComponentTitle", "compliancePostureId", "description", "frameworkControlId", "id", "implementationStatus" ], "type": "object" }, "dtos.CompliancePostureStatsDTO": { "properties": { "implemented": { "type": "integer" }, "notApplicable": { "type": "integer" }, "open": { "type": "integer" } }, "required": [ "implemented", "notApplicable", "open" ], "type": "object" }, "dtos.CompliancePostureWithControlDTO": { "properties": { "additional": { "type": "object" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "class": { "type": "string" }, "compliancePostureId": { "type": "string" }, "controlId": { "type": "string" }, "description": { "type": "string" }, "framework": { "type": "string" }, "frameworkControlId": { "type": "string" }, "importance": { "type": "string" }, "mappedControls": { "items": { "$ref": "#/components/schemas/dtos.MappedControlDTO" }, "type": "array", "uniqueItems": false }, "orgId": { "type": "string" }, "parentFrameworkControlId": { "type": "string" }, "projectId": { "type": "string" }, "securityLevel": { "type": "string" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "type": "string" }, "ticketUrl": { "type": "string" }, "title": { "type": "string" } }, "required": [ "additional", "assetId", "assetVersionName", "class", "compliancePostureId", "controlId", "description", "framework", "frameworkControlId", "importance", "mappedControls", "orgId", "parentFrameworkControlId", "projectId", "securityLevel", "state", "ticketId", "ticketUrl", "title" ], "type": "object" }, "dtos.CompliancePostureWithDetailsDTO": { "properties": { "additional": { "type": "object" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "byComponents": { "items": { "$ref": "#/components/schemas/dtos.ComplianceComponentImplementsControlStatementDTO" }, "type": "array", "uniqueItems": false }, "class": { "type": "string" }, "compliancePostureId": { "type": "string" }, "controlId": { "type": "string" }, "description": { "type": "string" }, "events": { "items": { "$ref": "#/components/schemas/dtos.VulnEventDTO" }, "type": "array", "uniqueItems": false }, "framework": { "type": "string" }, "frameworkControlId": { "type": "string" }, "importance": { "type": "string" }, "mappedControls": { "items": { "$ref": "#/components/schemas/dtos.MappedControlDTO" }, "type": "array", "uniqueItems": false }, "orgId": { "type": "string" }, "parentFrameworkControlId": { "type": "string" }, "projectId": { "type": "string" }, "securityLevel": { "type": "string" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "type": "string" }, "ticketUrl": { "type": "string" }, "title": { "type": "string" } }, "required": [ "additional", "assetId", "assetVersionName", "byComponents", "class", "compliancePostureId", "controlId", "description", "events", "framework", "frameworkControlId", "importance", "mappedControls", "orgId", "parentFrameworkControlId", "projectId", "securityLevel", "state", "ticketId", "ticketUrl", "title" ], "type": "object" }, "dtos.ComponentDTO": { "properties": { "componentType": { "$ref": "#/components/schemas/dtos.ComponentType" }, "dependsOn": { "items": { "$ref": "#/components/schemas/dtos.ComponentDependencyDTO" }, "type": "array", "uniqueItems": false }, "isLicenseOverwritten": { "type": "boolean" }, "license": { "type": "string" }, "project": { "$ref": "#/components/schemas/dtos.ComponentProjectDTO" }, "projectId": { "type": "string" }, "published": { "type": "string" }, "purl": { "description": "without qualifiers!", "type": "string" }, "version": { "type": "string" } }, "required": [ "componentType", "dependsOn", "isLicenseOverwritten", "license", "project", "projectId", "published", "purl", "version" ], "type": "object" }, "dtos.ComponentDependencyDTO": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/dtos.ArtifactDTO" }, "type": "array", "uniqueItems": false }, "component": { "$ref": "#/components/schemas/dtos.ComponentDTO" }, "componentPurl": { "type": "string" }, "dependency": { "$ref": "#/components/schemas/dtos.ComponentDTO" }, "dependencyPurl": { "description": "the provided sbom from cyclondx only contains the transitive dependencies, which do really get used\nthis means, that the dependency graph between people using the same library might differ, since they use it differently\nwe use edges, which provide the information, that a component is used by another component in one asset", "type": "string" }, "id": { "type": "string" } }, "required": [ "artifacts", "component", "componentPurl", "dependency", "dependencyPurl", "id" ], "type": "object" }, "dtos.ComponentOccurrenceAcrossInstance": { "properties": { "purl": { "type": "string" }, "relativeAmount": { "type": "number" }, "totalAmount": { "type": "integer" } }, "required": [ "purl", "relativeAmount", "totalAmount" ], "type": "object" }, "dtos.ComponentOccurrenceAcrossOrg": { "properties": { "purl": { "type": "string" }, "totalAmount": { "type": "integer" } }, "required": [ "purl", "totalAmount" ], "type": "object" }, "dtos.ComponentOccurrenceDTO": { "properties": { "artifactAssetVersion": { "type": "string" }, "artifactName": { "type": "string" }, "assetId": { "type": "string" }, "assetName": { "type": "string" }, "assetSlug": { "type": "string" }, "assetVersionName": { "type": "string" }, "assetVersionSlug": { "type": "string" }, "componentDependencyId": { "type": "string" }, "componentPurl": { "type": "string" }, "componentVersion": { "type": "string" }, "dependencyPurl": { "type": "string" }, "organizationId": { "type": "string" }, "organizationName": { "type": "string" }, "projectId": { "type": "string" }, "projectName": { "type": "string" }, "projectSlug": { "type": "string" } }, "required": [ "artifactAssetVersion", "artifactName", "assetId", "assetName", "assetSlug", "assetVersionName", "assetVersionSlug", "componentDependencyId", "componentPurl", "componentVersion", "dependencyPurl", "organizationId", "organizationName", "projectId", "projectName", "projectSlug" ], "type": "object" }, "dtos.ComponentProjectDTO": { "properties": { "description": { "type": "string" }, "forksCount": { "type": "integer" }, "homepage": { "type": "string" }, "license": { "type": "string" }, "openIssuesCount": { "type": "integer" }, "projectKey": { "description": "project name like \"github.com/facebook/react\"", "type": "string" }, "scoreCard": { "additionalProperties": {}, "type": "object" }, "scoreCardScore": { "type": "number" }, "starsCount": { "type": "integer" }, "updatedAt": { "type": "string" } }, "required": [ "description", "forksCount", "homepage", "license", "openIssuesCount", "projectKey", "scoreCard", "scoreCardScore", "starsCount", "updatedAt" ], "type": "object" }, "dtos.ComponentType": { "enum": [ "application", "container", "data", "device", "device-driver", "file", "firmware", "framework", "library", "machine-learning-model", "operating-system", "platform" ], "type": "string", "x-enum-varnames": [ "ComponentTypeApplication", "ComponentTypeContainer", "ComponentTypeData", "ComponentTypeDevice", "ComponentTypeDeviceDriver", "ComponentTypeFile", "ComponentTypeFirmware", "ComponentTypeFramework", "ComponentTypeLibrary", "ComponentTypeMachineLearningModel", "ComponentTypeOS", "ComponentTypePlatform" ] }, "dtos.CreateEventRequest": { "properties": { "justification": { "maxLength": 4000, "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "status": { "type": "string" } }, "required": [ "justification", "mechanicalJustification", "status" ], "type": "object" }, "dtos.CreateExternalReferenceRequest": { "properties": { "csafPackageScope": { "description": "only relevant for csaf references - NEEDS TO BE A VALID PURL", "type": "string" }, "type": { "$ref": "#/components/schemas/dtos.ExternalReferenceType", "enum": [ "cyclonedx", "csaf", "openvex" ] }, "url": { "type": "string" } }, "required": [ "csafPackageScope", "type", "url" ], "type": "object" }, "dtos.CreateInTotoLinkRequest": { "properties": { "filename": { "type": "string" }, "payload": { "type": "string" }, "step": { "type": "string" }, "supplyChainId": { "type": "string" }, "supplyChainOutputDigest": { "type": "string" } }, "required": [ "filename", "payload", "step", "supplyChainId", "supplyChainOutputDigest" ], "type": "object" }, "dtos.CreateVEXRuleRequest": { "properties": { "celExpression": { "type": "string" }, "eventType": { "$ref": "#/components/schemas/dtos.VulnEventType", "enum": [ "accepted", "falsePositive", "reopened" ] }, "justification": { "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "title": { "type": "string" }, "wasRecommended": { "type": "boolean" } }, "required": [ "celExpression", "eventType", "justification", "mechanicalJustification", "title", "wasRecommended" ], "type": "object" }, "dtos.DatabaseInfo": { "properties": { "error": { "type": "string" }, "idle": { "type": "integer" }, "inUse": { "type": "integer" }, "maxIdleClosed": { "type": "integer" }, "maxIdleTimeClosed": { "type": "integer" }, "maxLifetimeClosed": { "type": "integer" }, "maxOpenConnections": { "type": "integer" }, "migrationDirty": { "type": "boolean" }, "migrationError": { "type": "string" }, "migrationVersion": { "type": "integer" }, "openConnections": { "type": "integer" }, "pool": { "$ref": "#/components/schemas/dtos.PoolInfo" }, "status": { "type": "string" }, "vulndbVersion": { "type": "string" }, "waitCount": { "type": "integer" }, "waitDuration": { "$ref": "#/components/schemas/time.Duration" } }, "required": [ "error", "idle", "inUse", "maxIdleClosed", "maxIdleTimeClosed", "maxLifetimeClosed", "maxOpenConnections", "migrationDirty", "migrationError", "migrationVersion", "openConnections", "pool", "status", "vulndbVersion", "waitCount", "waitDuration" ], "type": "object" }, "dtos.DatabaseSpecifics": { "properties": { "cwe_ids": { "description": "array of cwe ids associated with this vulnerability", "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "cwe_ids" ], "type": "object" }, "dtos.DependencyVulnDTO": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/dtos.ArtifactDTO" }, "type": "array", "uniqueItems": false }, "assetId": { "type": "string" }, "assetSignature": { "example": "0", "type": "string" }, "assetVersionId": { "type": "string" }, "componentFixedVersion": { "type": "string" }, "componentPurl": { "type": "string" }, "createdAt": { "type": "string" }, "cve": { "$ref": "#/components/schemas/dtos.CVEDTO" }, "cveID": { "type": "string" }, "directDependencyFixedVersion": { "type": "string" }, "exploits": { "items": { "$ref": "#/components/schemas/dtos.ExploitDTO" }, "type": "array", "uniqueItems": false }, "id": { "type": "string" }, "lastStateChange": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "riskAssessment": { "type": "number" }, "riskRecalculatedAt": { "type": "string" }, "signature": { "example": "0", "type": "string" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "type": "string" }, "ticketUrl": { "type": "string" }, "vulnerabilityPath": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "artifacts", "assetId", "assetSignature", "assetVersionId", "componentFixedVersion", "componentPurl", "createdAt", "cve", "cveID", "directDependencyFixedVersion", "exploits", "id", "lastStateChange", "manualTicketCreation", "riskAssessment", "riskRecalculatedAt", "signature", "state", "ticketId", "ticketUrl", "vulnerabilityPath" ], "type": "object" }, "dtos.DetailedDependencyVulnDTO": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/dtos.ArtifactDTO" }, "type": "array", "uniqueItems": false }, "assetId": { "type": "string" }, "assetSignature": { "example": "0", "type": "string" }, "assetVersionId": { "type": "string" }, "componentFixedVersion": { "type": "string" }, "componentPurl": { "type": "string" }, "createdAt": { "type": "string" }, "cve": { "$ref": "#/components/schemas/dtos.CVEDTO" }, "cveID": { "type": "string" }, "directDependencyFixedVersion": { "type": "string" }, "events": { "items": { "$ref": "#/components/schemas/dtos.VulnEventDTO" }, "type": "array", "uniqueItems": false }, "exploits": { "items": { "$ref": "#/components/schemas/dtos.ExploitDTO" }, "type": "array", "uniqueItems": false }, "id": { "type": "string" }, "lastStateChange": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "riskAssessment": { "type": "number" }, "riskRecalculatedAt": { "type": "string" }, "signature": { "example": "0", "type": "string" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "type": "string" }, "ticketUrl": { "type": "string" }, "vulnerabilityPath": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "artifacts", "assetId", "assetSignature", "assetVersionId", "componentFixedVersion", "componentPurl", "createdAt", "cve", "cveID", "directDependencyFixedVersion", "events", "exploits", "id", "lastStateChange", "manualTicketCreation", "riskAssessment", "riskRecalculatedAt", "signature", "state", "ticketId", "ticketUrl", "vulnerabilityPath" ], "type": "object" }, "dtos.DetailedDependencyVulnWithRelationsDTO": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/dtos.ArtifactDTO" }, "type": "array", "uniqueItems": false }, "assetId": { "type": "string" }, "assetSignature": { "example": "0", "type": "string" }, "assetVersionId": { "type": "string" }, "componentFixedVersion": { "type": "string" }, "componentPurl": { "type": "string" }, "createdAt": { "type": "string" }, "cve": { "$ref": "#/components/schemas/dtos.CVEDTO" }, "cveID": { "type": "string" }, "directDependencyFixedVersion": { "type": "string" }, "events": { "items": { "$ref": "#/components/schemas/dtos.VulnEventDTO" }, "type": "array", "uniqueItems": false }, "exploits": { "items": { "$ref": "#/components/schemas/dtos.ExploitDTO" }, "type": "array", "uniqueItems": false }, "id": { "type": "string" }, "lastStateChange": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "related": { "additionalProperties": { "items": { "$ref": "#/components/schemas/dtos.CVEDTO" }, "type": "array" }, "type": "object" }, "riskAssessment": { "type": "number" }, "riskRecalculatedAt": { "type": "string" }, "signature": { "example": "0", "type": "string" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "type": "string" }, "ticketUrl": { "type": "string" }, "vulnerabilityPath": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "artifacts", "assetId", "assetSignature", "assetVersionId", "componentFixedVersion", "componentPurl", "createdAt", "cve", "cveID", "directDependencyFixedVersion", "events", "exploits", "id", "lastStateChange", "manualTicketCreation", "related", "riskAssessment", "riskRecalculatedAt", "signature", "state", "ticketId", "ticketUrl", "vulnerabilityPath" ], "type": "object" }, "dtos.DetailedFirstPartyVulnDTO": { "properties": { "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "author": { "type": "string" }, "commit": { "type": "string" }, "createdAt": { "type": "string" }, "date": { "type": "string" }, "email": { "type": "string" }, "events": { "items": { "$ref": "#/components/schemas/dtos.VulnEventDTO" }, "type": "array", "uniqueItems": false }, "id": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "message": { "type": "string" }, "ruleDescription": { "type": "string" }, "ruleHelp": { "type": "string" }, "ruleHelpURI": { "type": "string" }, "ruleId": { "type": "string" }, "ruleName": { "type": "string" }, "ruleProperties": { "additionalProperties": {}, "type": "object" }, "scannerIds": { "type": "string" }, "snippetContents": { "items": { "$ref": "#/components/schemas/dtos.SnippetContent" }, "type": "array", "uniqueItems": false }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "type": "string" }, "ticketUrl": { "type": "string" }, "uri": { "type": "string" } }, "required": [ "assetId", "assetVersionName", "author", "commit", "createdAt", "date", "email", "events", "id", "manualTicketCreation", "message", "ruleDescription", "ruleHelp", "ruleHelpURI", "ruleId", "ruleName", "ruleProperties", "scannerIds", "snippetContents", "state", "ticketId", "ticketUrl", "uri" ], "type": "object" }, "dtos.DetailedLicenseRiskDTO": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/dtos.LicenseRiskArtifactDTO" }, "type": "array", "uniqueItems": false }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "component": { "$ref": "#/components/schemas/dtos.ComponentDTO" }, "componentPurl": { "type": "string" }, "createdAt": { "type": "string" }, "events": { "items": { "$ref": "#/components/schemas/dtos.VulnEventDTO" }, "type": "array", "uniqueItems": false }, "finalLicenseDecision": { "type": "string" }, "id": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "type": "string" }, "ticketUrl": { "type": "string" } }, "required": [ "artifacts", "assetId", "assetVersionName", "component", "componentPurl", "createdAt", "events", "finalLicenseDecision", "id", "manualTicketCreation", "state", "ticketId", "ticketUrl" ], "type": "object" }, "dtos.EcosystemSpecific": { "properties": { "urgency": { "type": "string" } }, "required": [ "urgency" ], "type": "object" }, "dtos.EcosystemUsage": { "properties": { "absoluteAmount": { "type": "integer" }, "ecosystem": { "type": "string" }, "relativeAmount": { "type": "number" } }, "required": [ "absoluteAmount", "ecosystem", "relativeAmount" ], "type": "object" }, "dtos.ExploitDTO": { "properties": { "author": { "type": "string" }, "cveID": { "type": "string" }, "description": { "type": "string" }, "forks": { "type": "integer" }, "id": { "type": "string" }, "pushed_at": { "type": "string" }, "sourceURL": { "type": "string" }, "stargazers_count": { "type": "integer" }, "subscribers_count": { "type": "integer" }, "tags": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" }, "verified": { "type": "boolean" }, "watchers": { "type": "integer" } }, "required": [ "author", "cveID", "description", "forks", "id", "pushed_at", "sourceURL", "stargazers_count", "subscribers_count", "tags", "type", "updated_at", "verified", "watchers" ], "type": "object" }, "dtos.ExternalReferenceDTO": { "properties": { "assetId": { "type": "string" }, "error": { "description": "optional error message if the reference could not be processed", "type": "string" }, "type": { "$ref": "#/components/schemas/dtos.ExternalReferenceType" }, "url": { "type": "string" }, "vexRuleCount": { "type": "integer" } }, "required": [ "assetId", "error", "type", "url", "vexRuleCount" ], "type": "object" }, "dtos.ExternalReferenceError": { "properties": { "reason": { "type": "string" }, "url": { "type": "string" } }, "required": [ "reason", "url" ], "type": "object" }, "dtos.ExternalReferenceType": { "enum": [ "cyclonedx", "csaf", "openvex", "unknown" ], "type": "string", "x-enum-varnames": [ "ExternalReferenceTypeCycloneDX", "ExternalReferenceTypeCSAF", "ExternalReferenceTypeOpenVEX", "ExternalReferenceTypeUnknown" ] }, "dtos.ExternalSubprojectRequestDTO": { "properties": { "artifact": { "type": "string" }, "assetDescription": { "type": "string" }, "assetExternalEntityId": { "type": "string" }, "assetName": { "type": "string" }, "assetVersionName": { "type": "string" }, "projectDescription": { "type": "string" }, "projectExternalEntityId": { "type": "string" }, "projectName": { "type": "string" }, "sbom": { "items": { "type": "integer" }, "type": "array", "uniqueItems": false }, "subProjectDescription": { "type": "string" }, "subProjectExternalEntityId": { "type": "string" }, "subProjectName": { "type": "string" }, "verb": { "enum": [ "update", "delete" ], "type": "string" } }, "required": [ "artifact", "assetDescription", "assetExternalEntityId", "assetName", "assetVersionName", "projectDescription", "projectExternalEntityId", "projectName", "sbom", "subProjectDescription", "subProjectExternalEntityId", "subProjectName", "verb" ], "type": "object" }, "dtos.FirstPartyScanResponse": { "properties": { "amountClosed": { "type": "integer" }, "amountOpened": { "type": "integer" }, "firstPartyVulns": { "items": { "$ref": "#/components/schemas/dtos.FirstPartyVulnDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "amountClosed", "amountOpened", "firstPartyVulns" ], "type": "object" }, "dtos.FirstPartyVulnDTO": { "properties": { "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "author": { "type": "string" }, "commit": { "type": "string" }, "createdAt": { "type": "string" }, "date": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "message": { "type": "string" }, "ruleDescription": { "type": "string" }, "ruleHelp": { "type": "string" }, "ruleHelpURI": { "type": "string" }, "ruleId": { "type": "string" }, "ruleName": { "type": "string" }, "ruleProperties": { "additionalProperties": {}, "type": "object" }, "scannerIds": { "type": "string" }, "snippetContents": { "items": { "$ref": "#/components/schemas/dtos.SnippetContent" }, "type": "array", "uniqueItems": false }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "type": "string" }, "ticketUrl": { "type": "string" }, "uri": { "type": "string" } }, "required": [ "assetId", "assetVersionName", "author", "commit", "createdAt", "date", "email", "id", "manualTicketCreation", "message", "ruleDescription", "ruleHelp", "ruleHelpURI", "ruleId", "ruleName", "ruleProperties", "scannerIds", "snippetContents", "state", "ticketId", "ticketUrl", "uri" ], "type": "object" }, "dtos.FirstPartyVulnStatus": { "properties": { "justification": { "maxLength": 4000, "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "status": { "type": "string" } }, "required": [ "justification", "mechanicalJustification", "status" ], "type": "object" }, "dtos.GitRepository": { "properties": { "description": { "type": "string" }, "gitProvider": { "type": "string" }, "id": { "type": "string" }, "image": { "type": "string" }, "isDeveloper": { "type": "boolean" }, "isMaintainer": { "type": "boolean" }, "isOwner": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "description", "gitProvider", "id", "image", "isDeveloper", "isMaintainer", "isOwner", "label" ], "type": "object" }, "dtos.GithubAppInstallationDTO": { "properties": { "installationCreatedWebhookReceivedTime": { "type": "string" }, "installationId": { "type": "integer" }, "orgID": { "type": "string" }, "settingsUrl": { "type": "string" }, "targetAvatarUrl": { "type": "string" }, "targetLogin": { "type": "string" }, "targetType": { "type": "string" } }, "required": [ "installationCreatedWebhookReceivedTime", "installationId", "settingsUrl", "targetAvatarUrl", "targetLogin", "targetType" ], "type": "object" }, "dtos.GitlabIntegrationDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "obfuscatedToken": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "name", "obfuscatedToken", "url" ], "type": "object" }, "dtos.GitlabOauth2ConfigDTO": { "properties": { "gitlabBaseURL": { "type": "string" }, "providerID": { "type": "string" } }, "required": [ "gitlabBaseURL", "providerID" ], "type": "object" }, "dtos.InfoResponse": { "properties": { "build": { "$ref": "#/components/schemas/dtos.BuildInfo" }, "database": { "$ref": "#/components/schemas/dtos.DatabaseInfo" }, "process": { "$ref": "#/components/schemas/dtos.ProcessInfo" }, "runtime": { "$ref": "#/components/schemas/dtos.RuntimeInfo" } }, "required": [ "build", "database", "process", "runtime" ], "type": "object" }, "dtos.InstanceOverview": { "properties": { "averageOpenCodeRisks": { "type": "number" }, "averageOpenVulnsPerOrg": { "$ref": "#/components/schemas/dtos.OrgVulnAverage" }, "maliciousPackages": { "items": { "$ref": "#/components/schemas/dtos.MaliciousPackage" }, "type": "array", "uniqueItems": false }, "topCVEs": { "items": { "$ref": "#/components/schemas/dtos.CVEOccurrence" }, "type": "array", "uniqueItems": false }, "topComponents": { "items": { "$ref": "#/components/schemas/dtos.ComponentOccurrenceAcrossInstance" }, "type": "array", "uniqueItems": false }, "topVulnerableProjects": { "items": { "$ref": "#/components/schemas/dtos.ProjectVulnDistribution" }, "type": "array", "uniqueItems": false } }, "required": [ "averageOpenCodeRisks", "averageOpenVulnsPerOrg", "maliciousPackages", "topCVEs", "topComponents", "topVulnerableProjects" ], "type": "object" }, "dtos.InstanceSettingsDTO": { "properties": { "bearerTokenAuthDisabled": { "type": "boolean" }, "gitlabOAuth2Config": { "items": { "$ref": "#/components/schemas/dtos.GitlabOauth2ConfigDTO" }, "type": "array", "uniqueItems": false }, "singleOrganizationMode": { "type": "boolean" } }, "required": [ "bearerTokenAuthDisabled", "gitlabOAuth2Config", "singleOrganizationMode" ], "type": "object" }, "dtos.InstanceUsageStatistics": { "type": "object" }, "dtos.InvitationStatus": { "enum": [ "pending", "expired" ], "type": "string", "x-enum-varnames": [ "InvitationStatusPending", "InvitationStatusExpired" ] }, "dtos.InviteRequest": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "type": "object" }, "dtos.InvitedUserDTO": { "properties": { "email": { "type": "string" }, "expiryDate": { "type": "string" }, "id": { "type": "string" }, "invitationStatus": { "$ref": "#/components/schemas/dtos.InvitationStatus" } }, "required": [ "email", "expiryDate", "id", "invitationStatus" ], "type": "object" }, "dtos.JiraIntegrationDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "obfuscatedToken": { "type": "string" }, "url": { "type": "string" }, "userEmail": { "type": "string" } }, "required": [ "id", "name", "obfuscatedToken", "url", "userEmail" ], "type": "object" }, "dtos.LicenseRiskArtifactDTO": { "properties": { "artifactName": { "type": "string" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" } }, "required": [ "artifactName", "assetId", "assetVersionName" ], "type": "object" }, "dtos.LogDTO": { "properties": { "assetID": { "type": "string" }, "assetName": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "logLevel": { "type": "string" }, "message": { "type": "string" }, "orgID": { "type": "string" }, "orgName": { "type": "string" }, "projectID": { "type": "string" }, "projectName": { "type": "string" } }, "required": [ "assetID", "assetName", "createdAt", "id", "logLevel", "message", "orgID", "orgName", "projectID", "projectName" ], "type": "object" }, "dtos.LookupResponse": { "properties": { "asset": { "type": "string" }, "link": { "type": "string" }, "org": { "type": "string" }, "project": { "type": "string" } }, "required": [ "asset", "link", "org", "project" ], "type": "object" }, "dtos.MakeFinalLicenseDecisionRequest": { "properties": { "justification": { "maxLength": 4000, "type": "string" }, "license": { "type": "string" } }, "required": [ "justification", "license" ], "type": "object" }, "dtos.MaliciousPackage": { "properties": { "assetName": { "type": "string" }, "assetSlug": { "type": "string" }, "assetVersionName": { "type": "string" }, "component": { "type": "string" }, "maliciousPackageID": { "type": "string" }, "orgSlug": { "type": "string" }, "projectSlug": { "type": "string" } }, "required": [ "assetName", "assetSlug", "assetVersionName", "component", "maliciousPackageID", "orgSlug", "projectSlug" ], "type": "object" }, "dtos.MaliciousPackageInOrg": { "properties": { "assetName": { "type": "string" }, "assetVersionName": { "type": "string" }, "component": { "type": "string" }, "maliciousPackageID": { "type": "string" }, "projectName": { "type": "string" } }, "required": [ "assetName", "assetVersionName", "component", "maliciousPackageID", "projectName" ], "type": "object" }, "dtos.MappedControlDTO": { "properties": { "frameworkControlId": { "type": "string" }, "relatedControlId": { "type": "string" }, "relatedFramework": { "type": "string" }, "relationship": { "type": "string" } }, "required": [ "frameworkControlId", "relatedControlId", "relatedFramework", "relationship" ], "type": "object" }, "dtos.MechanicalJustificationType": { "enum": [ "component_not_present", "vulnerable_code_not_present", "vulnerable_code_not_in_execute_path", "vulnerable_code_cannot_be_controlled_by_adversary", "inline_mitigations_already_exist" ], "type": "string", "x-enum-varnames": [ "ComponentNotPresent", "VulnerableCodeNotPresent", "VulnerableCodeNotInExecutePath", "VulnerableCodeCannotBeControlledByAdversary", "InlineMitigationsAlreadyExist" ] }, "dtos.MemStats": { "properties": { "alloc": { "type": "integer" }, "heapAlloc": { "type": "integer" }, "sys": { "type": "integer" }, "totalAlloc": { "type": "integer" } }, "required": [ "alloc", "heapAlloc", "sys", "totalAlloc" ], "type": "object" }, "dtos.ModifiedAttackComplexity": { "enum": [ "low", "high", "X" ], "type": "string", "x-enum-varnames": [ "MACLow", "MACHigh", "MACNotDefined" ] }, "dtos.ModifiedAttackVector": { "enum": [ "network", "adjacent", "local", "physical", "X" ], "type": "string", "x-enum-varnames": [ "MAVNetwork", "MAVAdjacentNetwork", "MAVLocal", "MAVPhysical", "MAVNotDefined" ] }, "dtos.ModifiedPrivilegesRequired": { "enum": [ "none", "low", "high", "X" ], "type": "string", "x-enum-varnames": [ "MPRNone", "MPRLow", "MPRHigh", "MPRNotDefined" ] }, "dtos.ModifiedRequirementLevel": { "enum": [ "X", "none", "low", "high" ], "type": "string", "x-enum-varnames": [ "MRLNotDefined", "MRLNone", "MRLLow", "MRLHigh" ] }, "dtos.ModifiedScope": { "enum": [ "unchanged", "changed", "X" ], "type": "string", "x-enum-varnames": [ "MSUnchanged", "MSChanged", "MSNotDefined" ] }, "dtos.ModifiedUserInteraction": { "enum": [ "X", "none", "required" ], "type": "string", "x-enum-varnames": [ "MUINotDefined", "MUINone", "MUIRequired" ] }, "dtos.OSV": { "properties": { "affected": { "items": { "$ref": "#/components/schemas/dtos.Affected" }, "type": "array", "uniqueItems": false }, "aliases": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "database_specific": { "$ref": "#/components/schemas/dtos.DatabaseSpecifics", "description": "specific additional information, not standardized" }, "details": { "type": "string" }, "id": { "type": "string" }, "modified": { "type": "string" }, "published": { "type": "string" }, "related": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "severity": { "items": { "properties": { "score": { "type": "string" }, "type": { "type": "string" } }, "required": [ "score", "type" ], "type": "object" }, "type": "array", "uniqueItems": false }, "summary": { "type": "string" }, "upstream": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "withdrawn": { "type": "string" } }, "required": [ "affected", "aliases", "database_specific", "details", "id", "modified", "published", "related", "severity", "summary", "upstream", "withdrawn" ], "type": "object" }, "dtos.OrgChangeRoleRequest": { "properties": { "role": { "enum": [ "member", "admin" ], "type": "string" } }, "required": [ "role" ], "type": "object" }, "dtos.OrgCreateRequest": { "properties": { "contactPhoneNumber": { "type": "string" }, "country": { "type": "string" }, "criticalInfrastructure": { "type": "boolean" }, "description": { "type": "string" }, "grundschutz": { "type": "boolean" }, "industry": { "type": "string" }, "iso27001": { "type": "boolean" }, "language": { "type": "string" }, "name": { "type": "string" }, "nist": { "type": "boolean" }, "numberOfEmployees": { "type": "integer" } }, "required": [ "contactPhoneNumber", "country", "criticalInfrastructure", "description", "grundschutz", "industry", "iso27001", "language", "name", "nist", "numberOfEmployees" ], "type": "object" }, "dtos.OrgDTO": { "properties": { "configFiles": { "additionalProperties": {}, "type": "object" }, "contactPhoneNumber": { "type": "string" }, "country": { "type": "string" }, "createdAt": { "type": "string" }, "criticalInfrastructure": { "type": "boolean" }, "description": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "gitLabIntegrations": { "items": { "$ref": "#/components/schemas/dtos.GitlabIntegrationDTO" }, "type": "array", "uniqueItems": false }, "githubAppInstallations": { "items": { "$ref": "#/components/schemas/dtos.GithubAppInstallationDTO" }, "type": "array", "uniqueItems": false }, "grundschutz": { "type": "boolean" }, "id": { "type": "string" }, "industry": { "type": "string" }, "isPublic": { "type": "boolean" }, "iso27001": { "type": "boolean" }, "jiraIntegrations": { "items": { "$ref": "#/components/schemas/dtos.JiraIntegrationDTO" }, "type": "array", "uniqueItems": false }, "language": { "type": "string" }, "name": { "type": "string" }, "nist": { "type": "boolean" }, "numberOfEmployees": { "type": "integer" }, "projects": { "items": { "$ref": "#/components/schemas/dtos.ProjectDTO" }, "type": "array", "uniqueItems": false }, "sharesVulnInformation": { "type": "boolean" }, "slug": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "configFiles", "contactPhoneNumber", "country", "createdAt", "criticalInfrastructure", "description", "externalEntityProviderId", "gitLabIntegrations", "githubAppInstallations", "grundschutz", "id", "industry", "isPublic", "iso27001", "jiraIntegrations", "language", "name", "nist", "numberOfEmployees", "projects", "sharesVulnInformation", "slug", "updatedAt" ], "type": "object" }, "dtos.OrgDetailsDTO": { "properties": { "configFiles": { "additionalProperties": {}, "type": "object" }, "contactPhoneNumber": { "type": "string" }, "country": { "type": "string" }, "createdAt": { "type": "string" }, "criticalInfrastructure": { "type": "boolean" }, "description": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "gitLabIntegrations": { "items": { "$ref": "#/components/schemas/dtos.GitlabIntegrationDTO" }, "type": "array", "uniqueItems": false }, "githubAppInstallations": { "items": { "$ref": "#/components/schemas/dtos.GithubAppInstallationDTO" }, "type": "array", "uniqueItems": false }, "grundschutz": { "type": "boolean" }, "id": { "type": "string" }, "industry": { "type": "string" }, "invitedMembers": { "items": { "$ref": "#/components/schemas/dtos.InvitedUserDTO" }, "type": "array", "uniqueItems": false }, "isPublic": { "type": "boolean" }, "iso27001": { "type": "boolean" }, "jiraIntegrations": { "items": { "$ref": "#/components/schemas/dtos.JiraIntegrationDTO" }, "type": "array", "uniqueItems": false }, "language": { "type": "string" }, "members": { "items": { "$ref": "#/components/schemas/dtos.UserDTO" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "nist": { "type": "boolean" }, "numberOfEmployees": { "type": "integer" }, "projects": { "items": { "$ref": "#/components/schemas/dtos.ProjectDTO" }, "type": "array", "uniqueItems": false }, "sharesVulnInformation": { "type": "boolean" }, "slug": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "configFiles", "contactPhoneNumber", "country", "createdAt", "criticalInfrastructure", "description", "externalEntityProviderId", "gitLabIntegrations", "githubAppInstallations", "grundschutz", "id", "industry", "invitedMembers", "isPublic", "iso27001", "jiraIntegrations", "language", "members", "name", "nist", "numberOfEmployees", "projects", "sharesVulnInformation", "slug", "updatedAt" ], "type": "object" }, "dtos.OrgInformation": { "properties": { "owner_mail": { "type": "string" } }, "required": [ "owner_mail" ], "type": "object" }, "dtos.OrgOverview": { "properties": { "averageAgeOfDependencies": { "type": "number" }, "averageOpenCodeRisksPerProject": { "type": "number" }, "averageRemediationTimes": { "$ref": "#/components/schemas/dtos.AverageRemediationTimes" }, "maliciousPackages": { "items": { "$ref": "#/components/schemas/dtos.MaliciousPackageInOrg" }, "type": "array", "uniqueItems": false }, "orgRiskHistory": { "items": { "$ref": "#/components/schemas/dtos.OrgRiskHistory" }, "type": "array", "uniqueItems": false }, "remediationTypeDistribution": { "$ref": "#/components/schemas/dtos.RemediationTypeDistribution" }, "structure": { "$ref": "#/components/schemas/dtos.OrgStructureDistribution" }, "topArtifacts": { "items": { "$ref": "#/components/schemas/dtos.ArtifactVulnDistribution" }, "type": "array", "uniqueItems": false }, "topAssets": { "items": { "$ref": "#/components/schemas/dtos.AssetVulnDistribution" }, "type": "array", "uniqueItems": false }, "topCVEs": { "items": { "$ref": "#/components/schemas/dtos.CVEOccurrence" }, "type": "array", "uniqueItems": false }, "topComponents": { "items": { "$ref": "#/components/schemas/dtos.ComponentOccurrenceAcrossOrg" }, "type": "array", "uniqueItems": false }, "topEcosystems": { "items": { "$ref": "#/components/schemas/dtos.EcosystemUsage" }, "type": "array", "uniqueItems": false }, "topProjects": { "items": { "$ref": "#/components/schemas/dtos.ProjectVulnDistribution" }, "type": "array", "uniqueItems": false }, "vulnDistribution": { "$ref": "#/components/schemas/dtos.VulnSeverityDistribution" }, "vulnEventAverage": { "$ref": "#/components/schemas/dtos.AverageVulnEventsPerWeek" } }, "required": [ "averageAgeOfDependencies", "averageOpenCodeRisksPerProject", "averageRemediationTimes", "maliciousPackages", "orgRiskHistory", "remediationTypeDistribution", "structure", "topArtifacts", "topAssets", "topCVEs", "topComponents", "topEcosystems", "topProjects", "vulnDistribution", "vulnEventAverage" ], "type": "object" }, "dtos.OrgPatchRequest": { "properties": { "configFiles": { "additionalProperties": {}, "type": "object" }, "contactPhoneNumber": { "type": "string" }, "country": { "type": "string" }, "criticalInfrastructure": { "type": "boolean" }, "description": { "type": "string" }, "grundschutz": { "type": "boolean" }, "industry": { "type": "string" }, "isPublic": { "type": "boolean" }, "iso27001": { "type": "boolean" }, "language": { "type": "string" }, "name": { "type": "string" }, "nist": { "type": "boolean" }, "numberOfEmployees": { "type": "integer" }, "shareVulnInformation": { "type": "boolean" } }, "required": [ "configFiles", "contactPhoneNumber", "country", "criticalInfrastructure", "description", "grundschutz", "industry", "isPublic", "iso27001", "language", "name", "nist", "numberOfEmployees", "shareVulnInformation" ], "type": "object" }, "dtos.OrgRiskHistory": { "properties": { "critical": { "type": "integer" }, "criticalCvss": { "type": "integer" }, "cvePurlCritical": { "type": "integer" }, "cvePurlCriticalCvss": { "type": "integer" }, "cvePurlFixableCritical": { "type": "integer" }, "cvePurlFixableCriticalCvss": { "type": "integer" }, "cvePurlFixableHigh": { "type": "integer" }, "cvePurlFixableHighCvss": { "type": "integer" }, "cvePurlFixableLow": { "type": "integer" }, "cvePurlFixableLowCvss": { "type": "integer" }, "cvePurlFixableMedium": { "type": "integer" }, "cvePurlFixableMediumCvss": { "type": "integer" }, "cvePurlHigh": { "type": "integer" }, "cvePurlHighCvss": { "type": "integer" }, "cvePurlLow": { "type": "integer" }, "cvePurlLowCvss": { "type": "integer" }, "cvePurlMedium": { "type": "integer" }, "cvePurlMediumCvss": { "type": "integer" }, "day": { "type": "string" }, "fixableCritical": { "type": "integer" }, "fixableCriticalCvss": { "type": "integer" }, "fixableHigh": { "type": "integer" }, "fixableHighCvss": { "type": "integer" }, "fixableLow": { "type": "integer" }, "fixableLowCvss": { "type": "integer" }, "fixableMedium": { "type": "integer" }, "fixableMediumCvss": { "type": "integer" }, "high": { "type": "integer" }, "highCvss": { "type": "integer" }, "low": { "type": "integer" }, "lowCvss": { "type": "integer" }, "medium": { "type": "integer" }, "mediumCvss": { "type": "integer" } }, "required": [ "critical", "criticalCvss", "cvePurlCritical", "cvePurlCriticalCvss", "cvePurlFixableCritical", "cvePurlFixableCriticalCvss", "cvePurlFixableHigh", "cvePurlFixableHighCvss", "cvePurlFixableLow", "cvePurlFixableLowCvss", "cvePurlFixableMedium", "cvePurlFixableMediumCvss", "cvePurlHigh", "cvePurlHighCvss", "cvePurlLow", "cvePurlLowCvss", "cvePurlMedium", "cvePurlMediumCvss", "day", "fixableCritical", "fixableCriticalCvss", "fixableHigh", "fixableHighCvss", "fixableLow", "fixableLowCvss", "fixableMedium", "fixableMediumCvss", "high", "highCvss", "low", "lowCvss", "medium", "mediumCvss" ], "type": "object" }, "dtos.OrgSettingsDTO": { "properties": { "configFiles": { "additionalProperties": {}, "type": "object" }, "contactPhoneNumber": { "type": "string" }, "country": { "type": "string" }, "createdAt": { "type": "string" }, "criticalInfrastructure": { "type": "boolean" }, "description": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "gitLabIntegrations": { "items": { "$ref": "#/components/schemas/dtos.GitlabIntegrationDTO" }, "type": "array", "uniqueItems": false }, "githubAppInstallations": { "items": { "$ref": "#/components/schemas/dtos.GithubAppInstallationDTO" }, "type": "array", "uniqueItems": false }, "grundschutz": { "type": "boolean" }, "id": { "type": "string" }, "industry": { "type": "string" }, "invitedMembers": { "items": { "$ref": "#/components/schemas/dtos.InvitedUserDTO" }, "type": "array", "uniqueItems": false }, "isPublic": { "type": "boolean" }, "iso27001": { "type": "boolean" }, "jiraIntegrations": { "items": { "$ref": "#/components/schemas/dtos.JiraIntegrationDTO" }, "type": "array", "uniqueItems": false }, "language": { "type": "string" }, "members": { "items": { "$ref": "#/components/schemas/dtos.UserDTO" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "nist": { "type": "boolean" }, "numberOfEmployees": { "type": "integer" }, "projects": { "items": { "$ref": "#/components/schemas/dtos.ProjectDTO" }, "type": "array", "uniqueItems": false }, "sharesVulnInformation": { "type": "boolean" }, "slug": { "type": "string" }, "updatedAt": { "type": "string" }, "webhooks": { "items": { "$ref": "#/components/schemas/dtos.WebhookIntegrationDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "configFiles", "contactPhoneNumber", "country", "createdAt", "criticalInfrastructure", "description", "externalEntityProviderId", "gitLabIntegrations", "githubAppInstallations", "grundschutz", "id", "industry", "invitedMembers", "isPublic", "iso27001", "jiraIntegrations", "language", "members", "name", "nist", "numberOfEmployees", "projects", "sharesVulnInformation", "slug", "updatedAt", "webhooks" ], "type": "object" }, "dtos.OrgStructureDistribution": { "properties": { "numArtifacts": { "type": "integer" }, "numAssets": { "type": "integer" }, "numProjects": { "type": "integer" } }, "required": [ "numArtifacts", "numAssets", "numProjects" ], "type": "object" }, "dtos.OrgVulnAverage": { "properties": { "cvssAvgCritical": { "type": "number" }, "cvssAvgHigh": { "type": "number" }, "cvssAvgLow": { "type": "number" }, "cvssAvgMedium": { "type": "number" }, "riskAvgCritical": { "type": "number" }, "riskAvgHigh": { "type": "number" }, "riskAvgLow": { "type": "number" }, "riskAvgMedium": { "type": "number" } }, "required": [ "cvssAvgCritical", "cvssAvgHigh", "cvssAvgLow", "cvssAvgMedium", "riskAvgCritical", "riskAvgHigh", "riskAvgLow", "riskAvgMedium" ], "type": "object" }, "dtos.PATCreateResponseDTO": { "properties": { "bearerToken": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "expiryDateUnix": { "type": "integer" }, "fingerprint": { "type": "string" }, "id": { "type": "string" }, "lastUsedAt": { "type": "string" }, "scopes": { "type": "string" } }, "required": [ "bearerToken", "createdAt", "description", "expiryDateUnix", "fingerprint", "id", "lastUsedAt", "scopes" ], "type": "object" }, "dtos.PATDTO": { "properties": { "createdAt": { "type": "string" }, "description": { "type": "string" }, "expiryDateUnix": { "type": "integer" }, "fingerprint": { "type": "string" }, "id": { "type": "string" }, "lastUsedAt": { "type": "string" }, "scopes": { "type": "string" } }, "required": [ "createdAt", "description", "expiryDateUnix", "fingerprint", "id", "lastUsedAt", "scopes" ], "type": "object" }, "dtos.Package": { "properties": { "ecosystem": { "type": "string" }, "name": { "type": "string" }, "purl": { "type": "string" } }, "required": [ "ecosystem", "name", "purl" ], "type": "object" }, "dtos.PatCreateRequest": { "properties": { "description": { "type": "string" }, "expiryDateUnix": { "type": "integer" }, "pubKey": { "type": "string" }, "scopes": { "type": "string" } }, "required": [ "description", "expiryDateUnix", "pubKey", "scopes" ], "type": "object" }, "dtos.PermalinkResponse": { "properties": { "assetSlug": { "type": "string" }, "organizationSlug": { "type": "string" }, "projectSlug": { "type": "string" } }, "required": [ "assetSlug", "organizationSlug", "projectSlug" ], "type": "object" }, "dtos.PolicyDTO": { "properties": { "description": { "type": "string" }, "predicateType": { "type": "string" }, "priority": { "type": "integer" }, "rego": { "type": "string" }, "title": { "type": "string" } }, "required": [ "description", "predicateType", "priority", "rego", "title" ], "type": "object" }, "dtos.PoolInfo": { "properties": { "acquiredConns": { "type": "integer" }, "connMaxIdleTime": { "type": "string" }, "connMaxLifetime": { "type": "string" }, "dbName": { "type": "string" }, "idleConns": { "type": "integer" }, "maxConns": { "type": "integer" }, "maxOpenConns": { "type": "integer" }, "totalConns": { "type": "integer" } }, "required": [ "acquiredConns", "connMaxIdleTime", "connMaxLifetime", "dbName", "idleConns", "maxConns", "maxOpenConns", "totalConns" ], "type": "object" }, "dtos.ProcessInfo": { "properties": { "hostname": { "type": "string" }, "pid": { "type": "integer" }, "uptimeSeconds": { "type": "integer" } }, "required": [ "hostname", "pid", "uptimeSeconds" ], "type": "object" }, "dtos.ProjectAssetDTO": { "properties": { "avatar": { "description": "URL to the asset's avatar", "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "isPublic": { "type": "boolean" }, "name": { "type": "string" }, "parentId": { "description": "only set for projects, not for assets", "type": "string" }, "projectId": { "type": "string" }, "resourceType": { "description": "\"project\" or \"asset\"", "type": "string" }, "slug": { "type": "string" }, "state": { "type": "string" }, "subGroupsAndAsset": { "items": { "$ref": "#/components/schemas/dtos.ProjectAssetDTO" }, "type": "array", "uniqueItems": false }, "updatedAt": { "type": "string" } }, "required": [ "avatar", "createdAt", "description", "id", "isPublic", "name", "parentId", "projectId", "resourceType", "slug", "state", "subGroupsAndAsset", "updatedAt" ], "type": "object" }, "dtos.ProjectChangeRoleRequest": { "properties": { "role": { "enum": [ "member", "admin" ], "type": "string" } }, "required": [ "role" ], "type": "object" }, "dtos.ProjectCreateRequest": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parentId": { "description": "if created as a child project", "type": "string" }, "type": { "type": "string" } }, "required": [ "description", "name", "parentId", "type" ], "type": "object" }, "dtos.ProjectDTO": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/dtos.AssetDTO" }, "type": "array", "uniqueItems": false }, "avatar": { "description": "URL to the project's avatar", "type": "string" }, "configFiles": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "externalEntityId": { "description": "only set if this is an external entity", "type": "string" }, "externalEntityProviderId": { "type": "string" }, "id": { "type": "string" }, "isPublic": { "type": "boolean" }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/dtos.ProjectDTO", "description": "recursive structure" }, "parentId": { "type": "string" }, "repositoryId": { "type": "string" }, "repositoryName": { "type": "string" }, "slug": { "type": "string" }, "subGroupsAndAsset": { "items": { "$ref": "#/components/schemas/dtos.ProjectAssetDTO" }, "type": "array", "uniqueItems": false }, "type": { "type": "string" } }, "required": [ "assets", "avatar", "configFiles", "description", "externalEntityId", "externalEntityProviderId", "id", "isPublic", "name", "parent", "parentId", "repositoryId", "repositoryName", "slug", "subGroupsAndAsset", "type" ], "type": "object" }, "dtos.ProjectDetailsDTO": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/dtos.AssetDTO" }, "type": "array", "uniqueItems": false }, "avatar": { "description": "URL to the project's avatar", "type": "string" }, "configFiles": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "externalEntityId": { "description": "only set if this is an external entity", "type": "string" }, "externalEntityProviderId": { "type": "string" }, "id": { "type": "string" }, "isPublic": { "type": "boolean" }, "members": { "items": { "$ref": "#/components/schemas/dtos.UserDTO" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "parent": { "$ref": "#/components/schemas/dtos.ProjectDTO", "description": "recursive structure" }, "parentId": { "type": "string" }, "repositoryId": { "type": "string" }, "repositoryName": { "type": "string" }, "slug": { "type": "string" }, "subGroupsAndAsset": { "items": { "$ref": "#/components/schemas/dtos.ProjectAssetDTO" }, "type": "array", "uniqueItems": false }, "type": { "type": "string" }, "webhooks": { "items": { "$ref": "#/components/schemas/dtos.WebhookIntegrationDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "assets", "avatar", "configFiles", "description", "externalEntityId", "externalEntityProviderId", "id", "isPublic", "members", "name", "parent", "parentId", "repositoryId", "repositoryName", "slug", "subGroupsAndAsset", "type", "webhooks" ], "type": "object" }, "dtos.ProjectExternalEntityTree": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/dtos.AssetEntryDTO" }, "type": "array", "uniqueItems": false }, "projectExternalEntityId": { "type": "string" }, "projectName": { "type": "string" }, "subProjects": { "items": { "$ref": "#/components/schemas/dtos.SubProjectEntryDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "assets", "projectExternalEntityId", "projectName", "subProjects" ], "type": "object" }, "dtos.ProjectInviteRequest": { "properties": { "ids": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "ids" ], "type": "object" }, "dtos.ProjectPatchRequest": { "properties": { "configFiles": { "additionalProperties": {}, "type": "object" }, "description": { "type": "string" }, "isPublic": { "type": "boolean" }, "name": { "type": "string" }, "repositoryId": { "type": "string" }, "repositoryName": { "type": "string" }, "type": { "type": "string" } }, "required": [ "configFiles", "description", "isPublic", "name", "repositoryId", "repositoryName", "type" ], "type": "object" }, "dtos.ProjectVulnDistribution": { "properties": { "critical": { "type": "integer" }, "criticalCvss": { "type": "integer" }, "high": { "type": "integer" }, "highCvss": { "type": "integer" }, "low": { "type": "integer" }, "lowCvss": { "type": "integer" }, "medium": { "type": "integer" }, "mediumCvss": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "critical", "criticalCvss", "high", "highCvss", "low", "lowCvss", "medium", "mediumCvss", "name", "slug" ], "type": "object" }, "dtos.Range": { "properties": { "events": { "items": { "$ref": "#/components/schemas/dtos.SemverEvent" }, "type": "array", "uniqueItems": false }, "repo": { "type": "string" }, "type": { "type": "string" } }, "required": [ "events", "repo", "type" ], "type": "object" }, "dtos.Recommendation": { "properties": { "recommendedVersion": { "type": "string" } }, "required": [ "recommendedVersion" ], "type": "object" }, "dtos.RelationshipDTO": { "properties": { "relationshipType": { "type": "string" }, "targetCve": { "type": "string" } }, "required": [ "relationshipType", "targetCve" ], "type": "object" }, "dtos.RelationshipType": { "enum": [ "alias", "upstream", "related", "euvd", "advisory" ], "type": "string", "x-enum-comments": { "RelationshipTypeAdvisory": "flag relationships which stem from ingested security advisories", "RelationshipTypeEUVD": "flag relationships only imported through euvd explicitly" }, "x-enum-varnames": [ "RelationshipTypeAlias", "RelationshipTypeUpstream", "RelationshipTypeRelated", "RelationshipTypeEUVD", "RelationshipTypeAdvisory" ] }, "dtos.ReleaseCreateRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/dtos.ReleaseItemDTO" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" } }, "required": [ "items", "name" ], "type": "object" }, "dtos.ReleaseDTO": { "properties": { "createdAt": { "type": "string" }, "id": { "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/dtos.ReleaseItemDTO" }, "type": "array", "uniqueItems": false }, "name": { "type": "string" }, "projectId": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "createdAt", "id", "items", "name", "projectId", "updatedAt" ], "type": "object" }, "dtos.ReleaseItemDTO": { "properties": { "artifactName": { "type": "string" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "childReleaseId": { "type": "string" }, "childReleaseName": { "type": "string" }, "id": { "type": "string" }, "releaseId": { "type": "string" } }, "required": [ "artifactName", "assetId", "assetVersionName", "childReleaseId", "childReleaseName", "id", "releaseId" ], "type": "object" }, "dtos.ReleasePatchRequest": { "properties": { "items": { "items": { "$ref": "#/components/schemas/dtos.ReleaseItemDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "items" ], "type": "object" }, "dtos.RemediationTimeAverages": { "properties": { "cvssAvgCritical": { "type": "number" }, "cvssAvgHigh": { "type": "number" }, "cvssAvgLow": { "type": "number" }, "cvssAvgMedium": { "type": "number" }, "riskAvgCritical": { "type": "number" }, "riskAvgHigh": { "type": "number" }, "riskAvgLow": { "type": "number" }, "riskAvgMedium": { "type": "number" } }, "required": [ "cvssAvgCritical", "cvssAvgHigh", "cvssAvgLow", "cvssAvgMedium", "riskAvgCritical", "riskAvgHigh", "riskAvgLow", "riskAvgMedium" ], "type": "object" }, "dtos.RemediationTypeDistribution": { "properties": { "acceptedPercentage": { "type": "number" }, "falsePositivePercentage": { "type": "number" }, "fixedPercentage": { "type": "number" } }, "required": [ "acceptedPercentage", "falsePositivePercentage", "fixedPercentage" ], "type": "object" }, "dtos.RequirementLevel": { "enum": [ "low", "medium", "high" ], "type": "string", "x-enum-varnames": [ "RequirementLevelLow", "RequirementLevelMedium", "RequirementLevelHigh" ] }, "dtos.RevokeByPrivateKeyRequest": { "properties": { "privkey": { "type": "string" } }, "required": [ "privkey" ], "type": "object" }, "dtos.RiskHistoryDTO": { "properties": { "artifactName": { "type": "string" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "averageClosedRisk": { "type": "number" }, "averageOpenRisk": { "type": "number" }, "critical": { "type": "integer" }, "criticalCvss": { "type": "integer" }, "cvePurlCritical": { "type": "integer" }, "cvePurlCriticalCvss": { "type": "integer" }, "cvePurlFixableCritical": { "type": "integer" }, "cvePurlFixableCriticalCvss": { "type": "integer" }, "cvePurlFixableHigh": { "type": "integer" }, "cvePurlFixableHighCvss": { "type": "integer" }, "cvePurlFixableLow": { "type": "integer" }, "cvePurlFixableLowCvss": { "type": "integer" }, "cvePurlFixableMedium": { "type": "integer" }, "cvePurlFixableMediumCvss": { "type": "integer" }, "cvePurlHigh": { "type": "integer" }, "cvePurlHighCvss": { "type": "integer" }, "cvePurlLow": { "type": "integer" }, "cvePurlLowCvss": { "type": "integer" }, "cvePurlMedium": { "type": "integer" }, "cvePurlMediumCvss": { "type": "integer" }, "day": { "description": "on the day 2024-08-12 the asset had a sumRisk of 25.", "type": "string" }, "fixableCritical": { "type": "integer" }, "fixableCriticalCvss": { "type": "integer" }, "fixableHigh": { "type": "integer" }, "fixableHighCvss": { "type": "integer" }, "fixableLow": { "type": "integer" }, "fixableLowCvss": { "type": "integer" }, "fixableMedium": { "type": "integer" }, "fixableMediumCvss": { "type": "integer" }, "fixedDependencyVulns": { "type": "integer" }, "high": { "type": "integer" }, "highCvss": { "type": "integer" }, "low": { "type": "integer" }, "lowCvss": { "type": "integer" }, "maxClosedRisk": { "type": "number" }, "maxOpenRisk": { "type": "number" }, "medium": { "type": "integer" }, "mediumCvss": { "type": "integer" }, "minClosedRisk": { "type": "number" }, "minOpenRisk": { "type": "number" }, "openDependencyVulns": { "type": "integer" }, "sumClosedRisk": { "type": "number" }, "sumOpenRisk": { "type": "number" } }, "required": [ "artifactName", "assetId", "assetVersionName", "averageClosedRisk", "averageOpenRisk", "critical", "criticalCvss", "cvePurlCritical", "cvePurlCriticalCvss", "cvePurlFixableCritical", "cvePurlFixableCriticalCvss", "cvePurlFixableHigh", "cvePurlFixableHighCvss", "cvePurlFixableLow", "cvePurlFixableLowCvss", "cvePurlFixableMedium", "cvePurlFixableMediumCvss", "cvePurlHigh", "cvePurlHighCvss", "cvePurlLow", "cvePurlLowCvss", "cvePurlMedium", "cvePurlMediumCvss", "day", "fixableCritical", "fixableCriticalCvss", "fixableHigh", "fixableHighCvss", "fixableLow", "fixableLowCvss", "fixableMedium", "fixableMediumCvss", "fixedDependencyVulns", "high", "highCvss", "low", "lowCvss", "maxClosedRisk", "maxOpenRisk", "medium", "mediumCvss", "minClosedRisk", "minOpenRisk", "openDependencyVulns", "sumClosedRisk", "sumOpenRisk" ], "type": "object" }, "dtos.RiskHistoryWithVersionDTO": { "properties": { "artifactName": { "type": "string" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "averageClosedRisk": { "type": "number" }, "averageOpenRisk": { "type": "number" }, "critical": { "type": "integer" }, "criticalCvss": { "type": "integer" }, "cvePurlCritical": { "type": "integer" }, "cvePurlCriticalCvss": { "type": "integer" }, "cvePurlFixableCritical": { "type": "integer" }, "cvePurlFixableCriticalCvss": { "type": "integer" }, "cvePurlFixableHigh": { "type": "integer" }, "cvePurlFixableHighCvss": { "type": "integer" }, "cvePurlFixableLow": { "type": "integer" }, "cvePurlFixableLowCvss": { "type": "integer" }, "cvePurlFixableMedium": { "type": "integer" }, "cvePurlFixableMediumCvss": { "type": "integer" }, "cvePurlHigh": { "type": "integer" }, "cvePurlHighCvss": { "type": "integer" }, "cvePurlLow": { "type": "integer" }, "cvePurlLowCvss": { "type": "integer" }, "cvePurlMedium": { "type": "integer" }, "cvePurlMediumCvss": { "type": "integer" }, "day": { "description": "on the day 2024-08-12 the asset had a sumRisk of 25.", "type": "string" }, "defaultBranch": { "type": "boolean" }, "fixableCritical": { "type": "integer" }, "fixableCriticalCvss": { "type": "integer" }, "fixableHigh": { "type": "integer" }, "fixableHighCvss": { "type": "integer" }, "fixableLow": { "type": "integer" }, "fixableLowCvss": { "type": "integer" }, "fixableMedium": { "type": "integer" }, "fixableMediumCvss": { "type": "integer" }, "fixedDependencyVulns": { "type": "integer" }, "high": { "type": "integer" }, "highCvss": { "type": "integer" }, "low": { "type": "integer" }, "lowCvss": { "type": "integer" }, "maxClosedRisk": { "type": "number" }, "maxOpenRisk": { "type": "number" }, "medium": { "type": "integer" }, "mediumCvss": { "type": "integer" }, "minClosedRisk": { "type": "number" }, "minOpenRisk": { "type": "number" }, "openDependencyVulns": { "type": "integer" }, "slug": { "type": "string" }, "sumClosedRisk": { "type": "number" }, "sumOpenRisk": { "type": "number" }, "type": { "type": "string" } }, "required": [ "artifactName", "assetId", "assetVersionName", "averageClosedRisk", "averageOpenRisk", "critical", "criticalCvss", "cvePurlCritical", "cvePurlCriticalCvss", "cvePurlFixableCritical", "cvePurlFixableCriticalCvss", "cvePurlFixableHigh", "cvePurlFixableHighCvss", "cvePurlFixableLow", "cvePurlFixableLowCvss", "cvePurlFixableMedium", "cvePurlFixableMediumCvss", "cvePurlHigh", "cvePurlHighCvss", "cvePurlLow", "cvePurlLowCvss", "cvePurlMedium", "cvePurlMediumCvss", "day", "defaultBranch", "fixableCritical", "fixableCriticalCvss", "fixableHigh", "fixableHighCvss", "fixableLow", "fixableLowCvss", "fixableMedium", "fixableMediumCvss", "fixedDependencyVulns", "high", "highCvss", "low", "lowCvss", "maxClosedRisk", "maxOpenRisk", "medium", "mediumCvss", "minClosedRisk", "minOpenRisk", "openDependencyVulns", "slug", "sumClosedRisk", "sumOpenRisk", "type" ], "type": "object" }, "dtos.RiskMetrics": { "properties": { "baseScore": { "type": "number" }, "withEnvironment": { "type": "number" }, "withEnvironmentAndThreatIntelligence": { "type": "number" }, "withThreatIntelligence": { "type": "number" } }, "required": [ "baseScore", "withEnvironment", "withEnvironmentAndThreatIntelligence", "withThreatIntelligence" ], "type": "object" }, "dtos.RuntimeInfo": { "properties": { "goVersion": { "type": "string" }, "mem": { "$ref": "#/components/schemas/dtos.MemStats" }, "numGoroutines": { "type": "integer" } }, "required": [ "goVersion", "mem", "numGoroutines" ], "type": "object" }, "dtos.ScanResponse": { "properties": { "amountClosed": { "type": "integer" }, "amountOpened": { "type": "integer" }, "dependencyVulns": { "items": { "$ref": "#/components/schemas/dtos.DependencyVulnDTO" }, "type": "array", "uniqueItems": false } }, "required": [ "amountClosed", "amountOpened", "dependencyVulns" ], "type": "object" }, "dtos.SemverEvent": { "properties": { "fixed": { "type": "string" }, "introduced": { "type": "string" }, "last_affected": { "type": "string" } }, "required": [ "fixed", "introduced", "last_affected" ], "type": "object" }, "dtos.SnippetContent": { "properties": { "endColumn": { "type": "integer" }, "endLine": { "type": "integer" }, "snippet": { "type": "string" }, "startColumn": { "type": "integer" }, "startLine": { "type": "integer" } }, "required": [ "endColumn", "endLine", "snippet", "startColumn", "startLine" ], "type": "object" }, "dtos.SubProjectEntryDTO": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/dtos.AssetEntryDTO" }, "type": "array", "uniqueItems": false }, "subProjectDescription": { "type": "string" }, "subProjectExternalEntityId": { "type": "string" }, "subProjectName": { "type": "string" } }, "required": [ "assets", "subProjectDescription", "subProjectExternalEntityId", "subProjectName" ], "type": "object" }, "dtos.TestVEXRulesRequest": { "properties": { "celExpression": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "eventType": { "$ref": "#/components/schemas/dtos.VulnEventType", "enum": [ "accepted", "falsePositive", "reopened" ] } }, "required": [ "celExpression", "eventType" ], "type": "object" }, "dtos.UpdateAssetRequest": { "properties": { "new_slug": { "type": "string" } }, "required": [ "new_slug" ], "type": "object" }, "dtos.UpdateInstanceSettingsRequest": { "properties": { "disable_org_creation": { "description": "pointer makes it nil-able so we can distinguish a missing/ incorrectly parsed value (rather than the default value = false)", "type": "boolean" } }, "required": [ "disable_org_creation" ], "type": "object" }, "dtos.UserDTO": { "properties": { "avatarUrl": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" } }, "required": [ "avatarUrl", "id", "name", "role" ], "type": "object" }, "dtos.VEXRuleDTO": { "properties": { "appliesToAmountOfDependencyVulns": { "description": "Metrics", "type": "integer" }, "assetId": { "description": "Composite key components", "type": "string" }, "celExpression": { "type": "string" }, "createdAt": { "type": "string" }, "createdById": { "type": "string" }, "cveId": { "type": "string" }, "eventType": { "$ref": "#/components/schemas/dtos.VulnEventType" }, "id": { "description": "Primary key", "type": "string" }, "justification": { "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "pathPattern": { "items": { "type": "string" }, "type": "array", "uniqueItems": false }, "title": { "description": "Rule data", "type": "string" }, "vexSource": { "type": "string" } }, "required": [ "appliesToAmountOfDependencyVulns", "assetId", "celExpression", "createdAt", "createdById", "cveId", "eventType", "id", "justification", "mechanicalJustification", "pathPattern", "title", "vexSource" ], "type": "object" }, "dtos.VexRuleRecommendation": { "properties": { "assetSignature": { "example": "0", "type": "string" }, "assetSlug": { "type": "string" }, "celExpression": { "type": "string" }, "confidence": { "type": "number" }, "dependencyVulnSignature": { "example": "0", "type": "string" }, "eventType": { "$ref": "#/components/schemas/dtos.VulnEventType" }, "justification": { "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "projectSlug": { "description": "ProjectSlug/OriginAssetSlug are set when this recommendation was\ntaken directly from a rule on an asset the requesting user already has\naccess to, rather than from the crowd-voted recommendation across\nevery matching rule. Lets the frontend link to that project/asset.", "type": "string" }, "source": { "type": "string" }, "title": { "type": "string" }, "totalVotes": { "type": "integer" }, "type": { "$ref": "#/components/schemas/dtos.VexRuleRecommendationType" }, "verifiedVotes": { "type": "integer" } }, "required": [ "assetSignature", "assetSlug", "celExpression", "confidence", "dependencyVulnSignature", "eventType", "justification", "mechanicalJustification", "projectSlug", "source", "title", "totalVotes", "type", "verifiedVotes" ], "type": "object" }, "dtos.VexRuleRecommendationType": { "enum": [ "session", "crowdsourced", "upstream" ], "type": "string", "x-enum-varnames": [ "VexRuleRecommendationTypeSession", "VexRuleRecommendationTypeCrowdsourced", "VexRuleRecommendationTypeUpstream" ] }, "dtos.VulnEventDTO": { "properties": { "createdAt": { "type": "string" }, "createdByVexRule": { "type": "boolean" }, "id": { "type": "string" }, "justification": { "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "originalAssetVersionName": { "type": "string" }, "packageName": { "type": "string" }, "type": { "$ref": "#/components/schemas/dtos.VulnEventType" }, "uri": { "type": "string" }, "userAgent": { "type": "string" }, "userId": { "type": "string" }, "vexRule": { "$ref": "#/components/schemas/dtos.VEXRuleDTO" }, "vexRuleId": { "type": "string" }, "vulnId": { "type": "string" }, "vulnType": { "$ref": "#/components/schemas/dtos.VulnType" }, "vulnerabilityName": { "type": "string" } }, "required": [ "createdAt", "createdByVexRule", "id", "justification", "mechanicalJustification", "originalAssetVersionName", "packageName", "type", "uri", "userAgent", "userId", "vexRule", "vexRuleId", "vulnId", "vulnType", "vulnerabilityName" ], "type": "object" }, "dtos.VulnEventType": { "enum": [ "fixed", "licenseDecision", "reopened", "accepted", "mitigate", "falsePositive", "markedForTransfer", "comment", "published", "withdrawn", "created", "implemented", "notApplicable", "attachedComplianceComponent", "removedComplianceComponent", "detected", "rawRiskAssessmentUpdated" ], "type": "string", "x-enum-varnames": [ "EventTypeFixed", "EventTypeLicenseDecision", "EventTypeReopened", "EventTypeAccepted", "EventTypeMitigate", "EventTypeFalsePositive", "EventTypeMarkedForTransfer", "EventTypeComment", "EventTypePublish", "EventTypeWithdraw", "EventTypeCreated", "EventTypeImplemented", "EventTypeNotApplicable", "EventTypeAttachedComplianceComponent", "EventTypeRemovedComplianceComponent", "EventTypeDetected", "EventTypeRawRiskAssessmentUpdated" ] }, "dtos.VulnInPackageDTO": { "properties": { "cveId": { "type": "string" }, "fixedVersion": { "type": "string" } }, "required": [ "cveId", "fixedVersion" ], "type": "object" }, "dtos.VulnSeverityDistribution": { "properties": { "critical": { "type": "integer" }, "criticalCvss": { "type": "integer" }, "high": { "type": "integer" }, "highCvss": { "type": "integer" }, "low": { "type": "integer" }, "lowCvss": { "type": "integer" }, "medium": { "type": "integer" }, "mediumCvss": { "type": "integer" } }, "required": [ "critical", "criticalCvss", "high", "highCvss", "low", "lowCvss", "medium", "mediumCvss" ], "type": "object" }, "dtos.VulnState": { "enum": [ "open", "fixed", "accepted", "falsePositive", "markedForTransfer", "implemented", "notApplicable", "draft", "public", "withdrawn" ], "type": "string", "x-enum-comments": { "VulnStateAccepted": "like ignore", "VulnStateDraft": "for advisory", "VulnStateFalsePositive": "we can use that for crowdsource vulnerability management. 27 People marked this as false positive and they have the same dependency tree - propably you are not either", "VulnStateFixed": "we did not find the dependencyVuln anymore in the last scan!", "VulnStateImplemented": "for compliance posture", "VulnStateNotApplicable": "for compliance posture", "VulnStatePublished": "for advisory", "VulnStateWithdrawn": "for advisory" }, "x-enum-varnames": [ "VulnStateOpen", "VulnStateFixed", "VulnStateAccepted", "VulnStateFalsePositive", "VulnStateMarkedForTransfer", "VulnStateImplemented", "VulnStateNotApplicable", "VulnStateDraft", "VulnStatePublished", "VulnStateWithdrawn" ] }, "dtos.VulnType": { "enum": [ "dependencyVuln", "firstPartyVuln", "licenseRisk", "compliancePosture", "securityAdvisory" ], "type": "string", "x-enum-varnames": [ "VulnTypeDependencyVuln", "VulnTypeFirstPartyVuln", "VulnTypeLicenseRisk", "VulnTypeCompliancePosture", "VulnTypeSecurityAdvisory" ] }, "dtos.WebhookCreateRequestDTO": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "sbomEnabled": { "type": "boolean" }, "secret": { "type": "string" }, "url": { "type": "string" }, "vulnEnabled": { "type": "boolean" } }, "required": [ "description", "name", "sbomEnabled", "secret", "url", "vulnEnabled" ], "type": "object" }, "dtos.WebhookIntegrationDTO": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "sbomEnabled": { "type": "boolean" }, "url": { "type": "string" }, "vulnEnabled": { "type": "boolean" } }, "required": [ "description", "id", "name", "sbomEnabled", "url", "vulnEnabled" ], "type": "object" }, "dtos.WebhookTestRequestDTO": { "properties": { "payloadType": { "type": "string" }, "secret": { "type": "string" }, "url": { "type": "string" } }, "required": [ "payloadType", "secret", "url" ], "type": "object" }, "dtos.WebhookUpdateRequestDTO": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "sbomEnabled": { "type": "boolean" }, "secret": { "type": "string" }, "url": { "type": "string" }, "vulnEnabled": { "type": "boolean" } }, "required": [ "description", "id", "name", "sbomEnabled", "secret", "url", "vulnEnabled" ], "type": "object" }, "echo.HTTPError": { "properties": { "message": {} }, "required": [ "message" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Advisory": { "properties": { "affectedPackages": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AffectedPackage" }, "type": "array", "uniqueItems": false }, "assetVersion": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetVersion" }, "assetVersionName": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "events": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.VulnEvent" }, "type": "array", "uniqueItems": false }, "id": { "type": "string" }, "lastStateChange": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "severity": { "type": "string" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "description": "might be set by integrations", "type": "string" }, "ticketUrl": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string" }, "vectorString": { "type": "string" }, "vulnAssetId": { "type": "string" } }, "required": [ "affectedPackages", "assetVersion", "assetVersionName", "createdAt", "description", "events", "id", "lastStateChange", "manualTicketCreation", "severity", "state", "ticketId", "ticketUrl", "title", "updatedAt", "vectorString", "vulnAssetId" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.AffectedComponent": { "properties": { "cves": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.CVE" }, "type": "array", "uniqueItems": false }, "ecosystem": { "type": "string" }, "id": { "type": "integer" }, "purl": { "type": "string" }, "semverEnd": { "type": "string" }, "semverStart": { "type": "string" }, "version": { "description": "either version or semver is defined", "type": "string" }, "versionFixed": { "description": "for non semver packages - if both are defined, THIS one should be used for displaying. We might fake semver versions just for database querying and ordering", "type": "string" }, "versionIntroduced": { "description": "for non semver packages - if both are defined, THIS one should be used for displaying. We might fake semver versions just for database querying and ordering", "type": "string" } }, "required": [ "cves", "ecosystem", "id", "purl", "semverEnd", "semverStart", "version", "versionFixed", "versionIntroduced" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.AffectedPackage": { "properties": { "createdAt": { "type": "string" }, "ecosystem": { "type": "string" }, "id": { "type": "string" }, "packageName": { "type": "string" }, "updatedAt": { "type": "string" }, "versionEnd": { "type": "string" }, "versionStart": { "type": "string" } }, "required": [ "createdAt", "ecosystem", "id", "packageName", "updatedAt", "versionEnd", "versionStart" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Artifact": { "properties": { "artifactName": { "type": "string" }, "assetVersion": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetVersion" }, "assetVersionName": { "type": "string" }, "createdAt": { "type": "string" }, "dependencyVulns": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.DependencyVuln" }, "type": "array", "uniqueItems": false }, "lastHistoryUpdate": { "type": "string" }, "licenseRisks": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.LicenseRisk" }, "type": "array", "uniqueItems": false }, "riskHistories": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.ArtifactRiskHistory" }, "type": "array", "uniqueItems": false }, "vulnAssetId": { "type": "string" } }, "required": [ "artifactName", "assetVersion", "assetVersionName", "createdAt", "dependencyVulns", "lastHistoryUpdate", "licenseRisks", "riskHistories", "vulnAssetId" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.ArtifactRiskHistory": { "properties": { "artifactName": { "type": "string" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "averageClosedRisk": { "type": "number" }, "averageOpenRisk": { "type": "number" }, "critical": { "type": "integer" }, "criticalCvss": { "type": "integer" }, "cvePurlCritical": { "type": "integer" }, "cvePurlCriticalCvss": { "type": "integer" }, "cvePurlFixableCritical": { "type": "integer" }, "cvePurlFixableCriticalCvss": { "type": "integer" }, "cvePurlFixableHigh": { "type": "integer" }, "cvePurlFixableHighCvss": { "type": "integer" }, "cvePurlFixableLow": { "type": "integer" }, "cvePurlFixableLowCvss": { "type": "integer" }, "cvePurlFixableMedium": { "type": "integer" }, "cvePurlFixableMediumCvss": { "type": "integer" }, "cvePurlHigh": { "type": "integer" }, "cvePurlHighCvss": { "type": "integer" }, "cvePurlLow": { "type": "integer" }, "cvePurlLowCvss": { "type": "integer" }, "cvePurlMedium": { "type": "integer" }, "cvePurlMediumCvss": { "type": "integer" }, "day": { "description": "on the day 2024-08-12 the asset had a sumRisk of 25.", "type": "string" }, "fixableCritical": { "type": "integer" }, "fixableCriticalCvss": { "type": "integer" }, "fixableHigh": { "type": "integer" }, "fixableHighCvss": { "type": "integer" }, "fixableLow": { "type": "integer" }, "fixableLowCvss": { "type": "integer" }, "fixableMedium": { "type": "integer" }, "fixableMediumCvss": { "type": "integer" }, "fixedDependencyVulns": { "type": "integer" }, "high": { "type": "integer" }, "highCvss": { "type": "integer" }, "low": { "type": "integer" }, "lowCvss": { "type": "integer" }, "maxClosedRisk": { "type": "number" }, "maxOpenRisk": { "type": "number" }, "medium": { "type": "integer" }, "mediumCvss": { "type": "integer" }, "minClosedRisk": { "type": "number" }, "minOpenRisk": { "type": "number" }, "openDependencyVulns": { "type": "integer" }, "sumClosedRisk": { "type": "number" }, "sumOpenRisk": { "type": "number" } }, "required": [ "artifactName", "assetId", "assetVersionName", "averageClosedRisk", "averageOpenRisk", "critical", "criticalCvss", "cvePurlCritical", "cvePurlCriticalCvss", "cvePurlFixableCritical", "cvePurlFixableCriticalCvss", "cvePurlFixableHigh", "cvePurlFixableHighCvss", "cvePurlFixableLow", "cvePurlFixableLowCvss", "cvePurlFixableMedium", "cvePurlFixableMediumCvss", "cvePurlHigh", "cvePurlHighCvss", "cvePurlLow", "cvePurlLowCvss", "cvePurlMedium", "cvePurlMediumCvss", "day", "fixableCritical", "fixableCriticalCvss", "fixableHigh", "fixableHighCvss", "fixableLow", "fixableLowCvss", "fixableMedium", "fixableMediumCvss", "fixedDependencyVulns", "high", "highCvss", "low", "lowCvss", "maxClosedRisk", "maxOpenRisk", "medium", "mediumCvss", "minClosedRisk", "minOpenRisk", "openDependencyVulns", "sumClosedRisk", "sumOpenRisk" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Asset": { "properties": { "availabilityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "avatar": { "type": "string" }, "confidentialityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "configFiles": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_types.JSONB" }, "createdAt": { "type": "string" }, "cvssAutomaticTicketThreshold": { "type": "number" }, "description": { "type": "string" }, "externalEntityId": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "id": { "type": "string" }, "importance": { "type": "integer" }, "integrityRequirement": { "$ref": "#/components/schemas/dtos.RequirementLevel" }, "isPublic": { "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_types.JSONB" }, "modifiedAttackComplexity": { "$ref": "#/components/schemas/dtos.ModifiedAttackComplexity" }, "modifiedAttackVector": { "$ref": "#/components/schemas/dtos.ModifiedAttackVector" }, "modifiedAvailability": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedConfidentiality": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedIntegrity": { "$ref": "#/components/schemas/dtos.ModifiedRequirementLevel" }, "modifiedPrivilegesRequired": { "$ref": "#/components/schemas/dtos.ModifiedPrivilegesRequired" }, "modifiedScope": { "$ref": "#/components/schemas/dtos.ModifiedScope" }, "modifiedUserInteraction": { "$ref": "#/components/schemas/dtos.ModifiedUserInteraction" }, "name": { "type": "string" }, "paranoidMode": { "type": "boolean" }, "pipelineLastRun": { "type": "string" }, "project": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Project" }, "projectId": { "type": "string" }, "refs": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetVersion" }, "type": "array", "uniqueItems": false }, "repositoryId": { "description": "the id will be prefixed with the provider name, e.g. github:\u003cgithub app installation id\u003e:123456", "type": "string" }, "repositoryName": { "type": "string" }, "repositoryProvider": { "type": "string" }, "riskAutomaticTicketThreshold": { "type": "number" }, "shareInformation": { "type": "boolean" }, "signingPubKey": { "type": "string" }, "slug": { "type": "string" }, "state": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetState" }, "type": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetType" }, "updatedAt": { "type": "string" }, "vulnAutoReopenAfterDays": { "description": "Auto-reopen configuration - number of days after which closed/accepted vulnerabilities should be reopened", "type": "integer" }, "webhookSecret": { "type": "string" } }, "required": [ "availabilityRequirement", "avatar", "confidentialityRequirement", "configFiles", "createdAt", "cvssAutomaticTicketThreshold", "description", "externalEntityId", "externalEntityProviderId", "id", "importance", "integrityRequirement", "isPublic", "metadata", "modifiedAttackComplexity", "modifiedAttackVector", "modifiedAvailability", "modifiedConfidentiality", "modifiedIntegrity", "modifiedPrivilegesRequired", "modifiedScope", "modifiedUserInteraction", "name", "paranoidMode", "pipelineLastRun", "project", "projectId", "refs", "repositoryId", "repositoryName", "repositoryProvider", "riskAutomaticTicketThreshold", "shareInformation", "signingPubKey", "slug", "state", "type", "updatedAt", "vulnAutoReopenAfterDays", "webhookSecret" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.AssetState": { "enum": [ "active", "archived", "deleted" ], "type": "string", "x-enum-varnames": [ "AssetStateActive", "AssetStateArchived", "AssetStateDeleted" ] }, "github_com_l3montree-dev_devguard_database_models.AssetType": { "enum": [ "application", "infrastructure" ], "type": "string", "x-enum-varnames": [ "AssetTypeApplication", "AssetTypeInfrastructure" ] }, "github_com_l3montree-dev_devguard_database_models.AssetVersion": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Artifact" }, "type": "array", "uniqueItems": false }, "asset": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Asset" }, "assetId": { "type": "string" }, "createdAt": { "type": "string" }, "defaultBranch": { "type": "boolean" }, "dependencyVulns": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.DependencyVuln" }, "type": "array", "uniqueItems": false }, "lastAccessedAt": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_types.JSONB" }, "name": { "type": "string" }, "signingPubKey": { "type": "string" }, "slug": { "type": "string" }, "supplyChains": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.SupplyChain" }, "type": "array", "uniqueItems": false }, "type": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetVersionType" }, "updatedAt": { "type": "string" } }, "required": [ "artifacts", "asset", "assetId", "createdAt", "defaultBranch", "dependencyVulns", "lastAccessedAt", "metadata", "name", "signingPubKey", "slug", "supplyChains", "type", "updatedAt" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.AssetVersionType": { "enum": [ "branch", "tag" ], "type": "string", "x-enum-varnames": [ "AssetVersionBranch", "AssetVersionTag" ] }, "github_com_l3montree-dev_devguard_database_models.Attestation": { "properties": { "artifact": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Artifact", "description": "Ensure foreign key field order matches Artifact primary key: ArtifactName, AssetVersionName, AssetID" }, "artifactName": { "type": "string" }, "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "content": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_types.JSONB" }, "createdAt": { "type": "string" }, "predicateType": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "artifact", "artifactName", "assetId", "assetVersionName", "content", "createdAt", "predicateType", "updatedAt" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.CVE": { "properties": { "affectedComponents": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AffectedComponent" }, "type": "array", "uniqueItems": false }, "cisaActionDue": { "format": "date", "type": "string" }, "cisaExploitAdd": { "format": "date", "type": "string" }, "cisaRequiredAction": { "type": "string" }, "cisaVulnerabilityName": { "type": "string" }, "contentHash": { "type": "integer" }, "cve": { "type": "string" }, "cves": { "description": "comma separated list of associated cwe ids", "type": "string" }, "cvss": { "type": "number" }, "dateLastModified": { "type": "string" }, "datePublished": { "type": "string" }, "description": { "type": "string" }, "epss": { "type": "number" }, "euvdExploitAdd": { "type": "string" }, "exploits": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Exploit" }, "type": "array", "uniqueItems": false }, "id": { "type": "integer" }, "percentile": { "type": "number" }, "references": { "type": "string" }, "relationships": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.CVERelationship" }, "type": "array", "uniqueItems": false }, "risk": { "$ref": "#/components/schemas/dtos.RiskMetrics" }, "vector": { "type": "string" }, "weaknesses": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Weakness" }, "type": "array", "uniqueItems": false }, "withdrawn": { "type": "string" } }, "required": [ "affectedComponents", "cisaActionDue", "cisaExploitAdd", "cisaRequiredAction", "cisaVulnerabilityName", "contentHash", "cve", "cves", "cvss", "dateLastModified", "datePublished", "description", "epss", "euvdExploitAdd", "exploits", "id", "percentile", "references", "relationships", "risk", "vector", "weaknesses", "withdrawn" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.CVERelationship": { "properties": { "relationship_type": { "$ref": "#/components/schemas/dtos.RelationshipType" }, "source_cve": { "description": "an external CVE-ID (like DEBIAN-CVE-...)", "type": "string" }, "target_cve": { "description": "the official CVE-XXXX-... the external CVE-ID relates to", "type": "string" }, "target_cve_data": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.CVE", "description": "TargetCVEData is populated by GORM nested preload. It is nil when the target\nCVE does not exist in this database — no DB-level FK constraint is added." } }, "required": [ "relationship_type", "source_cve", "target_cve", "target_cve_data" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Component": { "properties": { "componentType": { "$ref": "#/components/schemas/dtos.ComponentType" }, "id": { "description": "ID might be a PURL - but not always. Sometimes it is a file path to a binary or a \"fake node\" we are adding during normalization", "type": "string" }, "isLicenseOverwritten": { "type": "boolean" }, "license": { "type": "string" }, "project": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.ComponentProject" }, "projectId": { "type": "string" }, "published": { "type": "string" } }, "required": [ "componentType", "id", "isLicenseOverwritten", "license", "project", "projectId", "published" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.ComponentProject": { "properties": { "description": { "type": "string" }, "forksCount": { "type": "integer" }, "homepage": { "type": "string" }, "license": { "type": "string" }, "openIssuesCount": { "type": "integer" }, "projectKey": { "description": "project name like \"github.com/facebook/react\"", "type": "string" }, "scoreCard": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_types.JSONB" }, "scoreCardScore": { "type": "number" }, "starsCount": { "type": "integer" }, "updatedAt": { "type": "string" } }, "required": [ "description", "forksCount", "homepage", "license", "openIssuesCount", "projectKey", "scoreCard", "scoreCardScore", "starsCount", "updatedAt" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.DependencyVuln": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Artifact" }, "type": "array", "uniqueItems": false }, "assetSignature": { "description": "hash of cve_id + vulnerability_path + asset_id\nused by vuln events to deduplicate them.", "type": "integer" }, "assetVersion": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetVersion" }, "assetVersionName": { "type": "string" }, "componentFixedVersion": { "type": "string" }, "componentPurl": { "type": "string" }, "createdAt": { "type": "string" }, "cve": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.CVE" }, "cveId": { "type": "string" }, "directDependencyFixedVersion": { "type": "string" }, "events": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.VulnEvent" }, "type": "array", "uniqueItems": false }, "id": { "type": "string" }, "lastStateChange": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "riskAssessment": { "type": "number" }, "riskRecalculatedAt": { "type": "string" }, "signature": { "description": "hash of cve_id + vulnerability_path", "type": "integer" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "description": "might be set by integrations", "type": "string" }, "ticketUrl": { "type": "string" }, "updatedAt": { "type": "string" }, "vulnAssetId": { "type": "string" }, "vulnerabilityPath": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "artifacts", "assetSignature", "assetVersion", "assetVersionName", "componentFixedVersion", "componentPurl", "createdAt", "cve", "cveId", "directDependencyFixedVersion", "events", "id", "lastStateChange", "manualTicketCreation", "riskAssessment", "riskRecalculatedAt", "signature", "state", "ticketId", "ticketUrl", "updatedAt", "vulnAssetId", "vulnerabilityPath" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Exploit": { "properties": { "author": { "type": "string" }, "contentHash": { "type": "integer" }, "cveID": { "type": "string" }, "description": { "type": "string" }, "forks": { "type": "integer" }, "id": { "type": "string" }, "pushed_at": { "type": "string" }, "sourceURL": { "type": "string" }, "stargazers_count": { "type": "integer" }, "subscribers_count": { "type": "integer" }, "tags": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" }, "verified": { "type": "boolean" }, "watchers": { "type": "integer" } }, "required": [ "author", "contentHash", "cveID", "description", "forks", "id", "pushed_at", "sourceURL", "stargazers_count", "subscribers_count", "tags", "type", "updated_at", "verified", "watchers" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.GitLabIntegration": { "properties": { "createdAt": { "type": "string" }, "gitLabUrl": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "org": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "orgId": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "createdAt", "gitLabUrl", "id", "name", "org", "orgId", "updatedAt" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.GithubAppInstallation": { "properties": { "installationCreatedWebhookReceivedTime": { "type": "string" }, "installationId": { "type": "integer" }, "org": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "orgId": { "type": "string" }, "settingsUrl": { "type": "string" }, "targetAvatarUrl": { "type": "string" }, "targetLogin": { "type": "string" }, "targetType": { "type": "string" } }, "required": [ "installationCreatedWebhookReceivedTime", "installationId", "org", "orgId", "settingsUrl", "targetAvatarUrl", "targetLogin", "targetType" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.InTotoLink": { "properties": { "assetId": { "type": "string" }, "assetVersionName": { "type": "string" }, "createdAt": { "type": "string" }, "filename": { "type": "string" }, "pat": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.PAT" }, "patId": { "type": "string" }, "payload": { "description": "the real link payload", "type": "string" }, "step": { "type": "string" }, "supplyChainId": { "description": "this is used to identify the link afterwards.\nfor the post-commit link this is the commit hash", "type": "string" } }, "required": [ "assetId", "assetVersionName", "createdAt", "filename", "pat", "patId", "payload", "step", "supplyChainId" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Invitation": { "properties": { "code": { "type": "string" }, "createdAt": { "type": "string" }, "email": { "description": "Email is the email address of the user the invitation is for", "type": "string" }, "id": { "type": "string" }, "organization": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "organizationId": { "description": "OrganizationID is the ID of the organization the invitation is for", "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "code", "createdAt", "email", "id", "organizationId", "updatedAt" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.JiraIntegration": { "properties": { "accountId": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "org": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "orgId": { "type": "string" }, "updatedAt": { "type": "string" }, "url": { "type": "string" }, "userEmail": { "type": "string" } }, "required": [ "accountId", "createdAt", "id", "name", "org", "orgId", "updatedAt", "url", "userEmail" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.LicenseRisk": { "properties": { "artifacts": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Artifact" }, "type": "array", "uniqueItems": false }, "assetVersion": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetVersion" }, "assetVersionName": { "type": "string" }, "component": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Component" }, "componentPurl": { "description": "only valid purls", "type": "string" }, "createdAt": { "type": "string" }, "events": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.VulnEvent" }, "type": "array", "uniqueItems": false }, "finalLicenseDecision": { "type": "string" }, "id": { "type": "string" }, "lastStateChange": { "type": "string" }, "manualTicketCreation": { "type": "boolean" }, "state": { "$ref": "#/components/schemas/dtos.VulnState" }, "ticketId": { "description": "might be set by integrations", "type": "string" }, "ticketUrl": { "type": "string" }, "updatedAt": { "type": "string" }, "vulnAssetId": { "type": "string" } }, "required": [ "artifacts", "assetVersion", "assetVersionName", "component", "componentPurl", "createdAt", "events", "finalLicenseDecision", "id", "lastStateChange", "manualTicketCreation", "state", "ticketId", "ticketUrl", "updatedAt", "vulnAssetId" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Org": { "properties": { "configFiles": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_types.JSONB" }, "contactPhoneNumber": { "type": "string" }, "country": { "type": "string" }, "createdAt": { "type": "string" }, "criticalInfrastructure": { "type": "boolean" }, "description": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "gitLabIntegrations": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.GitLabIntegration" }, "type": "array", "uniqueItems": false }, "githubAppInstallations": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.GithubAppInstallation" }, "type": "array", "uniqueItems": false }, "grundschutz": { "type": "boolean" }, "id": { "type": "string" }, "industry": { "type": "string" }, "isPublic": { "type": "boolean" }, "iso27001": { "type": "boolean" }, "jiraIntegrations": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.JiraIntegration" }, "type": "array", "uniqueItems": false }, "language": { "type": "string" }, "name": { "type": "string" }, "nist": { "type": "boolean" }, "numberOfEmployees": { "type": "integer" }, "projects": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Project" }, "type": "array", "uniqueItems": false }, "sharesVulnInformation": { "type": "boolean" }, "slug": { "type": "string" }, "updatedAt": { "type": "string" }, "webhooks": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.WebhookIntegration" }, "type": "array", "uniqueItems": false } }, "required": [ "configFiles", "contactPhoneNumber", "country", "createdAt", "criticalInfrastructure", "description", "externalEntityProviderId", "gitLabIntegrations", "githubAppInstallations", "grundschutz", "id", "industry", "isPublic", "iso27001", "jiraIntegrations", "language", "name", "nist", "numberOfEmployees", "projects", "sharesVulnInformation", "slug", "updatedAt", "webhooks" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.PAT": { "properties": { "assetID": { "type": "string" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "expiryDate": { "type": "string" }, "fingerprint": { "type": "string" }, "id": { "type": "string" }, "lastUsedAt": { "type": "string" }, "orgID": { "type": "string" }, "projectID": { "type": "string" }, "pubKey": { "type": "string" }, "scopes": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "assetID", "createdAt", "description", "expiryDate", "fingerprint", "id", "lastUsedAt", "orgID", "projectID", "pubKey", "scopes", "userId" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Policy": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "opaqueId": { "description": "only used by global policies maintained by the community and migrated by the system", "type": "string" }, "organization": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "organizationId": { "description": "will be null for global policies", "type": "string" }, "predicateType": { "type": "string" }, "projects": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Project" }, "type": "array", "uniqueItems": false }, "rego": { "type": "string" }, "title": { "type": "string" } }, "required": [ "description", "id", "opaqueId", "organization", "organizationId", "predicateType", "projects", "rego", "title" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Project": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Asset" }, "type": "array", "uniqueItems": false }, "avatar": { "type": "string" }, "configFiles": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_types.JSONB" }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "enabledPolicies": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Policy" }, "type": "array", "uniqueItems": false }, "externalEntityId": { "type": "string" }, "externalEntityProviderId": { "type": "string" }, "externalEntityProviderParentId": { "type": "string" }, "id": { "type": "string" }, "isPublic": { "type": "boolean" }, "name": { "type": "string" }, "organization": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "organizationId": { "type": "string" }, "parent": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Project" }, "parentId": { "type": "string" }, "repositoryId": { "description": "the id will be prefixed with the provider name, e.g. github:\u003cgithub app installation id\u003e:123456", "type": "string" }, "repositoryName": { "type": "string" }, "slug": { "type": "string" }, "state": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.ProjectState" }, "type": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.ProjectType" }, "updatedAt": { "type": "string" }, "webhooks": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.WebhookIntegration" }, "type": "array", "uniqueItems": false } }, "required": [ "assets", "avatar", "configFiles", "createdAt", "description", "enabledPolicies", "externalEntityId", "externalEntityProviderId", "externalEntityProviderParentId", "id", "isPublic", "name", "organization", "organizationId", "parent", "parentId", "repositoryId", "repositoryName", "slug", "state", "type", "updatedAt", "webhooks" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.ProjectState": { "enum": [ "active", "deleted" ], "type": "string", "x-enum-varnames": [ "ProjectStateActive", "ProjectStateDeleted" ] }, "github_com_l3montree-dev_devguard_database_models.ProjectType": { "enum": [ "default", "dynamic" ], "type": "string", "x-enum-varnames": [ "ProjectTypeDefault", "ProjectTypeDynamic" ] }, "github_com_l3montree-dev_devguard_database_models.SupplyChain": { "properties": { "assetId": { "type": "string" }, "assetVersion": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetVersion" }, "assetVersionName": { "type": "string" }, "createdAt": { "type": "string" }, "supplyChainId": { "type": "string" }, "supplyChainOutputDigest": { "type": "string" }, "updatedAt": { "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "assetId", "assetVersion", "assetVersionName", "createdAt", "supplyChainId", "supplyChainOutputDigest", "updatedAt", "verified" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.VEXRule": { "properties": { "asset": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Asset", "description": "Relationships" }, "assetId": { "description": "Composite key components (for indexing and queries)", "type": "string" }, "celExpression": { "type": "string" }, "createdAt": { "type": "string" }, "createdById": { "type": "string" }, "cveScope": { "description": "optional CVE scope for filtering", "type": "string" }, "enabled": { "description": "Enabled indicates whether this rule should be applied to matching vulnerabilities.\nWhen false, the rule exists but does not create events or modify vulnerability state.\nRules are disabled when uploaded in ParanoidMode, requiring manual review/enabling.", "type": "boolean" }, "eventType": { "$ref": "#/components/schemas/dtos.VulnEventType" }, "id": { "description": "Single primary key - hash of composite components", "type": "string" }, "justification": { "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "recommendedRule": { "description": "this will be set, when the rule was recommended by the crowdsourced vexing algorithm.", "type": "boolean" }, "title": { "description": "Rule data", "type": "string" }, "vexSource": { "type": "string" } }, "required": [ "asset", "assetId", "celExpression", "createdAt", "createdById", "cveScope", "enabled", "eventType", "id", "justification", "mechanicalJustification", "recommendedRule", "title", "vexSource" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.VulnEvent": { "properties": { "assetSignature": { "description": "set instead of DependencyVulnID for a group event applying to every\nDependencyVuln sharing this AssetSignature.", "type": "integer" }, "compliancePostureId": { "type": "string" }, "createdAt": { "type": "string" }, "createdByVexRule": { "type": "boolean" }, "dependencyVulnId": { "type": "string" }, "firstPartyVulnId": { "type": "string" }, "id": { "type": "string" }, "justification": { "type": "string" }, "licenseRiskId": { "type": "string" }, "mechanicalJustification": { "$ref": "#/components/schemas/dtos.MechanicalJustificationType" }, "originalAssetVersionName": { "type": "string" }, "securityAdvisoryId": { "type": "string" }, "type": { "$ref": "#/components/schemas/dtos.VulnEventType" }, "userAgent": { "type": "string" }, "userId": { "type": "string" }, "vexRule": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.VEXRule" }, "vexRuleId": { "type": "string" } }, "required": [ "assetSignature", "compliancePostureId", "createdAt", "createdByVexRule", "dependencyVulnId", "firstPartyVulnId", "id", "justification", "licenseRiskId", "mechanicalJustification", "originalAssetVersionName", "securityAdvisoryId", "type", "userAgent", "userId", "vexRule", "vexRuleId" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.Weakness": { "properties": { "cve": { "type": "string" }, "cwe": { "type": "string" }, "source": { "type": "string" }, "type": { "type": "string" } }, "required": [ "cve", "cwe", "source", "type" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_models.WebhookIntegration": { "properties": { "createdAt": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "org": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "orgId": { "type": "string" }, "project": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Project" }, "projectId": { "type": "string" }, "sbomEnabled": { "type": "boolean" }, "secret": { "type": "string" }, "updatedAt": { "type": "string" }, "url": { "type": "string" }, "vulnEnabled": { "type": "boolean" } }, "required": [ "createdAt", "description", "id", "name", "org", "orgId", "project", "projectId", "sbomEnabled", "secret", "updatedAt", "url", "vulnEnabled" ], "type": "object" }, "github_com_l3montree-dev_devguard_database_types.JSONB": { "additionalProperties": {}, "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-dtos_CompliancePostureWithControlDTO": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.CompliancePostureWithControlDTO" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-dtos_ComponentDependencyDTO": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.ComponentDependencyDTO" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-dtos_ComponentOccurrenceDTO": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.ComponentOccurrenceDTO" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-dtos_LogDTO": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.LogDTO" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-dtos_ProjectAssetDTO": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.ProjectAssetDTO" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-dtos_ProjectDTO": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.ProjectDTO" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-dtos_ReleaseDTO": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.ReleaseDTO" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-dtos_VulnEventDTO": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.VulnEventDTO" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-github_com_l3montree-dev_devguard_database_models_Advisory": { "properties": { "data": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Advisory" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "github_com_l3montree-dev_devguard_shared.Paged-github_com_l3montree-dev_devguard_database_models_Project": { "properties": { "data": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Project" }, "type": "array", "uniqueItems": false }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "data", "page", "pageSize", "total" ], "type": "object" }, "licenses.License": { "properties": { "detailsURL": { "type": "string" }, "isDeprecatedLicenseId": { "type": "boolean" }, "isOsiApproved": { "type": "boolean" }, "licenseId": { "type": "string" }, "name": { "type": "string" }, "reference": { "type": "string" }, "referenceNumber": { "type": "integer" }, "seeAlso": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "detailsURL", "isDeprecatedLicenseId", "isOsiApproved", "licenseId", "name", "reference", "referenceNumber", "seeAlso" ], "type": "object" }, "normalize.PurlMatchContext": { "properties": { "howToInterpretVersionString": { "$ref": "#/components/schemas/normalize.VersionInterpretationType" }, "namespace": { "type": "string" }, "normalizedVersion": { "type": "string" }, "originalVersion": { "type": "string" }, "qualifiers": { "items": { "$ref": "#/components/schemas/packageurl.Qualifier" }, "type": "array", "uniqueItems": false }, "searchPurl": { "description": "purl without version and qualifiers, used for database matching", "type": "string" } }, "required": [ "howToInterpretVersionString", "namespace", "normalizedVersion", "originalVersion", "qualifiers", "searchPurl" ], "type": "object" }, "normalize.VersionInterpretationType": { "enum": [ "exact", "semver_range", "empty_version", "ecosystem_specific" ], "type": "string", "x-enum-varnames": [ "ExactVersionString", "SemanticVersionString", "EmptyVersion", "EcosystemSpecificVersion" ] }, "packageurl.Qualifier": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "shared.InstanceSettings": { "properties": { "bearerTokenAuthDisabled": { "type": "boolean" }, "singleOrganizationMode": { "type": "boolean" } }, "required": [ "bearerTokenAuthDisabled", "singleOrganizationMode" ], "type": "object" }, "time.Duration": { "enum": [ -9223372036854775808, 9223372036854775807, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000, -9223372036854775808, 9223372036854775807, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000, -9223372036854775808, 9223372036854775807, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000, -9223372036854775808, 9223372036854775807, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000 ], "type": "integer", "x-enum-varnames": [ "minDuration", "maxDuration", "Nanosecond", "Microsecond", "Millisecond", "Second", "Minute", "Hour", "minDuration", "maxDuration", "Nanosecond", "Microsecond", "Millisecond", "Second", "Minute", "Hour", "minDuration", "maxDuration", "Nanosecond", "Microsecond", "Millisecond", "Second", "Minute", "Hour", "minDuration", "maxDuration", "Nanosecond", "Microsecond", "Millisecond", "Second", "Minute", "Hour", "Nanosecond", "Microsecond", "Millisecond", "Second", "Minute", "Hour", "Nanosecond", "Microsecond", "Millisecond", "Second", "Minute", "Hour", "Nanosecond", "Microsecond", "Millisecond", "Second", "Minute", "Hour" ] }, "transformer.MinimalTree": { "properties": { "dependencies": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" }, "nodes": { "items": { "type": "string" }, "type": "array", "uniqueItems": false } }, "required": [ "dependencies", "nodes" ], "type": "object" } }, "securitySchemes": { "AdminSignedAuth": { "description": "Instance admin authentication using ECDSA P-256 HTTP message signing. Requires Signature, Signature-Input and Content-Digest headers.", "in": "header", "name": "Signature", "type": "apiKey" }, "BearerAuth": { "description": "Bearer token authentication. Set value to: Bearer dvg_…", "in": "header", "name": "Authorization", "type": "apiKey" }, "CookieAuth": { "description": "Session-based authentication using Ory Kratos", "in": "cookie", "name": "ory_kratos_session", "type": "apiKey" }, "PATAuth": { "description": "Personal Access Token authentication using HTTP request signing. Requires X-Signature and X-Fingerprint headers.", "in": "header", "name": "X-Signature", "type": "apiKey" } } }, "info": { "contact": { "name": "Support", "url": "https://github.com/l3montree-dev/devguard/issues" }, "description": "DevGuard Backend. Secure your Software Supply Chain. Attestation-based compliance as Code, manage your CVEs seamlessly, Integrate your Vulnerability Scanners, Security Framework Documentation made easy. OWASP Incubating Project", "license": { "name": "AGPL-3", "url": "https://github.com/l3montree-dev/devguard/blob/main/LICENSE.txt" }, "title": "DevGuard API", "version": "v1" }, "externalDocs": { "description": "", "url": "" }, "paths": { "/.well-known/csaf-aggregator/aggregator.json": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "summary": "Get CSAF aggregator metadata", "tags": [ "CSAF" ] } }, "/accept-invitation": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AcceptInvitationRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Accept organization invitation", "tags": [ "Organizations" ] } }, "/admin": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Confirm admin credentials are accepted", "tags": [ "Admin" ] } }, "/admin/assets/{assetID}/": { "patch": { "parameters": [ { "description": "Asset ID", "in": "path", "name": "assetID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.UpdateAssetRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Update an asset's slug", "tags": [ "Admin" ] } }, "/admin/daemons/asset-pipeline-all/trigger": { "post": { "description": "Runs the full asset pipeline (scan, sync, risk calculation, statistics) for every asset on this instance. Returns an SSE stream with log, done, and error events. Subject to a 5-minute cooldown.", "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "SSE stream (event: log | done | error)" }, "429": { "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/echo.HTTPError" } } }, "description": "Cooldown not elapsed – try again later" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Trigger the asset pipeline for all assets", "tags": [ "Admin Daemons" ] } }, "/admin/daemons/asset-pipeline-single/trigger": { "post": { "description": "Runs the full asset pipeline for one asset identified by its UUID. Returns an SSE stream with log, done, and error events. Subject to a 5-minute cooldown per asset.", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } }, "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "SSE stream (event: log | done | error)" }, "400": { "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/echo.HTTPError" } } }, "description": "Invalid or missing assetId" }, "429": { "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/echo.HTTPError" } } }, "description": "Cooldown not elapsed – try again later" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Trigger the asset pipeline for a single asset", "tags": [ "Admin Daemons" ] } }, "/admin/daemons/fixed-versions/trigger": { "post": { "description": "Updates known fixed versions for tracked vulnerabilities. Returns an SSE stream with log, done, and error events. Subject to a 5-minute cooldown.", "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "SSE stream (event: log | done | error)" }, "429": { "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/echo.HTTPError" } } }, "description": "Cooldown not elapsed – try again later" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Trigger the Fixed Versions daemon", "tags": [ "Admin Daemons" ] } }, "/admin/daemons/open-source-insights/trigger": { "post": { "description": "Syncs open-source project metadata from deps.dev. Returns an SSE stream with log, done, and error events. Subject to a 5-minute cooldown (enforced across all API instances via the config DB).", "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "SSE stream (event: log | done | error)" }, "429": { "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/echo.HTTPError" } } }, "description": "Cooldown not elapsed – try again later" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Trigger the Open Source Insights daemon", "tags": [ "Admin Daemons" ] } }, "/admin/daemons/vulndb/trigger": { "post": { "description": "Runs an incremental VulnDB import from upstream diffs. Sets the vulndb.vulndb config timestamp at the start of processing. Returns an SSE stream with log, done, and error events. Subject to a 5-minute cooldown.", "responses": { "200": { "content": { "text/event-stream": { "schema": { "type": "string" } } }, "description": "SSE stream (event: log | done | error)" }, "429": { "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/echo.HTTPError" } } }, "description": "Cooldown not elapsed – try again later" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Trigger the VulnDB import daemon", "tags": [ "Admin Daemons" ] } }, "/admin/external-orgs/": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.AdminsInOrg" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Get admins for all external organizations", "tags": [ "Admin" ] } }, "/admin/external-orgs/{orgID}/admins/{userID}/": { "delete": { "parameters": [ { "description": "Organization ID", "in": "path", "name": "orgID", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "userID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Revoke admin role from a user in an organization", "tags": [ "Admin" ] } }, "/admin/external-orgs/{orgID}/admins/{userMail}/": { "put": { "parameters": [ { "description": "Organization ID", "in": "path", "name": "orgID", "required": true, "schema": { "type": "string" } }, { "description": "User email", "in": "path", "name": "userMail", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Add an admin to an organization", "tags": [ "Admin" ] } }, "/admin/logs/": { "get": { "parameters": [ { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size", "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Sort query, e.g. sort[createdAt]=desc", "in": "query", "name": "sort", "schema": { "type": "string" } }, { "description": "Filter query, e.g. filterQuery[logs.log_level][is]=error", "in": "query", "name": "filterQuery", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_LogDTO" } } }, "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Get logs", "tags": [ "Admin" ] } }, "/admin/organizations/{orgID}/": { "get": { "parameters": [ { "description": "Organization ID", "in": "path", "name": "orgID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgInformation" } } }, "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Get information about an organization", "tags": [ "Admin" ] } }, "/admin/settings/": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shared.InstanceSettings" } } }, "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Get instance settings", "tags": [ "Admin" ] }, "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.UpdateInstanceSettingsRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Update instance settings", "tags": [ "Admin" ] } }, "/admin/statistics/usage/": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.InstanceUsageStatistics" } } }, "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Get instance usage statistics", "tags": [ "Admin" ] } }, "/admin/statistics/vulnerabilities/": { "get": { "parameters": [ { "description": "Limit of top CVEs to return", "in": "query", "name": "topCVEsLimit", "schema": { "type": "integer" } }, { "description": "Limit of top components to return", "in": "query", "name": "topComponentsLimit", "schema": { "type": "integer" } }, { "description": "Limit of top projects to return", "in": "query", "name": "topProjectsLimit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.InstanceOverview" } } }, "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Get instance vulnerability statistics", "tags": [ "Admin" ] } }, "/admin/users/{userID}/": { "get": { "parameters": [ { "description": "User ID", "in": "path", "name": "userID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "AdminSignedAuth": [] } ], "summary": "Get organizations where the user is owner", "tags": [ "Admin" ] } }, "/api/v2/sarif-scan": { "post": { "parameters": [ { "description": "Asset name as \u003corganization\u003e/\u003cproject\u003e/\u003casset\u003e", "in": "header", "name": "X-Asset-Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "SARIF scan result", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Enriched SARIF JSON" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Scan SARIF file and return enriched SARIF", "tags": [ "Scanning" ] } }, "/api/v2/sarif-scan-unauthenticated": { "post": { "parameters": [ { "description": "Scanner ID", "in": "header", "name": "X-Scanner", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "SARIF scan result", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Enriched SARIF JSON" } }, "summary": "Scan SARIF without authentication and return enriched SARIF", "tags": [ "Scanning" ] } }, "/api/v2/scan": { "post": { "parameters": [ { "description": "Asset name as \u003corganization\u003e/\u003cproject\u003e/\u003casset\u003e", "in": "header", "name": "X-Asset-Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cyclonedx.BOM", "summary": "body", "description": "CycloneDX SBOM" } } }, "description": "CycloneDX SBOM", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cyclonedx.BOM" } } }, "description": "CycloneDX VEX JSON" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Scan SBOM file and return CycloneDX VEX", "tags": [ "Scanning" ] } }, "/api/v2/scan-unauthenticated": { "post": { "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "CycloneDX SBOM", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cyclonedx.BOM" } } }, "description": "CycloneDX VEX JSON" } }, "summary": "Scan for dependency vulnerabilities without authentication, returns CycloneDX VEX", "tags": [ "Scanning" ] } }, "/attestations": { "post": { "parameters": [ { "description": "Asset version name", "in": "header", "name": "X-Asset-Ref", "schema": { "type": "string" } }, { "description": "Artifact name", "in": "header", "name": "X-Artifact-Name", "schema": { "type": "string" } }, { "description": "Predicate type", "in": "header", "name": "X-Predicate-Type", "schema": { "type": "string" } }, { "description": "Asset name as \u003corganization\u003e/\u003cproject\u003e/\u003casset\u003e", "in": "header", "name": "X-Asset-Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "Attestation content", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create attestation", "tags": [ "Attestations" ] } }, "/compliance-components/": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.ComplianceComponentDetailsDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List all compliance components", "tags": [ "Compliance Components" ] } }, "/compliance-components/{complianceComponentID}/": { "get": { "parameters": [ { "description": "Compliance component ID", "in": "path", "name": "complianceComponentID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ComplianceComponentDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get compliance component details", "tags": [ "Compliance Components" ] } }, "/dependency-proxy/composer/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Composer repository request", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/deb/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Debian repository request", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/go": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Go module requests", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/go/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Go module requests", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/maven/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Maven repository request", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/npm/-/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm registry API request", "tags": [ "Dependency Firewall" ] }, "post": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm registry API request", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/npm/{package}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "npm package name", "in": "path", "name": "package", "schema": { "type": "string" } }, { "description": "npm scope", "in": "path", "name": "scope", "schema": { "type": "string" } }, { "description": "npm package name (scoped)", "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm package metadata", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/npm/{package}/-/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "npm package name", "in": "path", "name": "package", "schema": { "type": "string" } }, { "description": "npm scope", "in": "path", "name": "scope", "schema": { "type": "string" } }, { "description": "npm package name (scoped)", "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm tarball download", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/npm/{scope}/{name}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "npm package name", "in": "path", "name": "package", "schema": { "type": "string" } }, { "description": "npm scope", "in": "path", "name": "scope", "schema": { "type": "string" } }, { "description": "npm package name (scoped)", "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm package metadata", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/npm/{scope}/{name}/-/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "npm package name", "in": "path", "name": "package", "schema": { "type": "string" } }, { "description": "npm scope", "in": "path", "name": "scope", "schema": { "type": "string" } }, { "description": "npm package name (scoped)", "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm tarball download", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/pypi/packages/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy PyPI package download", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/pypi/simple/{package}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "PyPI package name", "in": "path", "name": "package", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "HTML simple index" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy PyPI simple index metadata", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/composer/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Composer repository request", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/deb/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Debian repository request", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/go": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Go module requests", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/go/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Go module requests", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/maven/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy Maven repository request", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/npm/-/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm registry API request", "tags": [ "Dependency Firewall" ] }, "post": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm registry API request", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/npm/{package}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "npm package name", "in": "path", "name": "package", "schema": { "type": "string" } }, { "description": "npm scope", "in": "path", "name": "scope", "schema": { "type": "string" } }, { "description": "npm package name (scoped)", "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm package metadata", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/npm/{package}/-/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "npm package name", "in": "path", "name": "package", "schema": { "type": "string" } }, { "description": "npm scope", "in": "path", "name": "scope", "schema": { "type": "string" } }, { "description": "npm package name (scoped)", "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm tarball download", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/npm/{scope}/{name}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "npm package name", "in": "path", "name": "package", "schema": { "type": "string" } }, { "description": "npm scope", "in": "path", "name": "scope", "schema": { "type": "string" } }, { "description": "npm package name (scoped)", "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm package metadata", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/npm/{scope}/{name}/-/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "npm package name", "in": "path", "name": "package", "schema": { "type": "string" } }, { "description": "npm scope", "in": "path", "name": "scope", "schema": { "type": "string" } }, { "description": "npm package name (scoped)", "in": "path", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy npm tarball download", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/pypi/packages/{path}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy PyPI package download", "tags": [ "Dependency Firewall" ] } }, "/dependency-proxy/{secret}/pypi/simple/{package}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "PyPI package name", "in": "path", "name": "package", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "HTML simple index" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy PyPI simple index metadata", "tags": [ "Dependency Firewall" ] } }, "/health": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "type": "object" } } }, "description": "OK" }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Liveness and readiness check", "tags": [ "System" ] } }, "/info": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.InfoResponse" } } }, "description": "OK" } }, "summary": "Runtime, build and database diagnostics", "tags": [ "System" ] } }, "/instance-settings": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.InstanceSettingsDTO" } } }, "description": "OK" } }, "summary": "Get public instance settings", "tags": [ "Admin" ] } }, "/integrations/repositories": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.GitRepository" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List repositories from integrations for the session", "tags": [ "Integrations" ] } }, "/lookup": { "get": { "parameters": [ { "description": "Provider name", "in": "query", "name": "provider", "required": true, "schema": { "type": "string" } }, { "description": "Repository ID", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.LookupResponse" } } }, "description": "OK" } }, "summary": "Lookup asset by provider", "tags": [ "Assets" ] } }, "/oauth2/gitlab/callback/{integrationName}": { "get": { "parameters": [ { "description": "Integration name", "in": "path", "name": "integrationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] } ], "summary": "GitLab OAuth2 callback", "tags": [ "Integrations" ] } }, "/oauth2/gitlab/{integrationName}": { "get": { "parameters": [ { "description": "Integration name", "in": "path", "name": "integrationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] } ], "summary": "GitLab OAuth2 login", "tags": [ "Integrations" ] } }, "/organizations": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List organizations", "tags": [ "Organizations" ] }, "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgCreateRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Org" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create organization", "tags": [ "Organizations" ] } }, "/organizations/{organization}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete organization", "tags": [ "Organizations" ] }, "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get organization details", "tags": [ "Organizations" ] }, "patch": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgPatchRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update organization", "tags": [ "Organizations" ] } }, "/organizations/{organization}/compliance-postures": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_CompliancePostureWithControlDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List compliance postures paged", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/compliance-postures/components/{statementID}/": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Statement ID", "in": "path", "name": "statementID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete a compliance statement", "tags": [ "Compliance Components" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Statement ID", "in": "path", "name": "statementID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.statementPayload", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ComplianceComponentImplementsControlStatementDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update a compliance statement", "tags": [ "Compliance Components" ] } }, "/organizations/{organization}/compliance-postures/oscal": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get OSCAL system security plan", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/compliance-postures/stats": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureStatsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get compliance posture stats", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/compliance-postures/{frameworkControlID}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Framework Control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureWithDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get compliance posture for a framework control", "tags": [ "Compliance Postures" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Framework Control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "justification": { "type": "string" }, "status": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "Event data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureWithDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a compliance posture event", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/compliance-postures/{frameworkControlID}/components/{complianceComponentID}/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Framework control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } }, { "description": "Compliance component ID", "in": "path", "name": "complianceComponentID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.statementPayload", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ComplianceComponentImplementsControlStatementDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a compliance statement for a component", "tags": [ "Compliance Components" ] } }, "/organizations/{organization}/components": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size", "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_ComponentOccurrenceDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Search component occurrences within an organization", "tags": [ "Components" ] } }, "/organizations/{organization}/config-files/{config-file}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Config file ID", "in": "path", "name": "config-file", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Config file content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get organization config file", "tags": [ "Organizations" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Config file ID", "in": "path", "name": "config-file", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "string" } } }, "description": "Config file content", "required": true }, "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Updated config file content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update organization config file", "tags": [ "Organizations" ] } }, "/organizations/{organization}/content-tree": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.ProjectDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get organization content tree", "tags": [ "Organizations" ] } }, "/organizations/{organization}/csaf/openpgp": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF OpenPGP keys HTML", "tags": [ "CSAF" ] } }, "/organizations/{organization}/csaf/openpgp/{file}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "File name", "in": "path", "name": "file", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF OpenPGP key or hash file", "tags": [ "CSAF" ] } }, "/organizations/{organization}/csaf/provider-metadata.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF provider metadata for organization", "tags": [ "CSAF" ] } }, "/organizations/{organization}/dependency-proxy-urls/": { "get": { "parameters": [ { "description": "organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get organization dependency proxy URLs", "tags": [ "Dependency Firewall" ] } }, "/organizations/{organization}/dependency-vulns": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List dependency vulnerabilities by organization", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/first-party-vulns": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List first-party vulnerabilities by organization", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/integrations/finish-installation/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Third party installation id", "in": "query", "name": "installationId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Finish a third-party integration installation", "tags": [ "Integrations" ] } }, "/organizations/{organization}/integrations/gitlab/test-and-save/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "token": { "type": "string" }, "url": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "GitLab credentials", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.GitlabIntegrationDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Test and save GitLab integration credentials", "tags": [ "Integrations" ] } }, "/organizations/{organization}/integrations/gitlab/{gitlab_integration_id}/": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "GitLab integration ID", "in": "path", "name": "gitlab_integration_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete a GitLab integration access token", "tags": [ "Integrations" ] } }, "/organizations/{organization}/integrations/jira/test-and-save/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "token": { "type": "string" }, "url": { "type": "string" }, "userEmail": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "Jira credentials", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.JiraIntegrationDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Test and save Jira integration credentials", "tags": [ "Integrations" ] } }, "/organizations/{organization}/integrations/jira/{jira_integration_id}/": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Jira integration ID", "in": "path", "name": "jira_integration_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete a Jira integration access token", "tags": [ "Integrations" ] } }, "/organizations/{organization}/integrations/repositories": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.GitRepository" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List repositories from integrations for an organization", "tags": [ "Integrations" ] } }, "/organizations/{organization}/integrations/webhook/test": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookTestRequestDTO", "summary": "body", "description": "Test webhook data" } } }, "description": "Test webhook data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "payloadType": { "type": "string" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Test webhook integration (org)", "tags": [ "Webhooks" ] } }, "/organizations/{organization}/integrations/webhook/test-and-save": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookCreateRequestDTO", "summary": "body", "description": "Webhook data" } } }, "description": "Webhook data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookIntegrationDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create webhook integration (org)", "tags": [ "Webhooks" ] } }, "/organizations/{organization}/integrations/webhook/{id}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Webhook ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete webhook integration (org)", "tags": [ "Webhooks" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Webhook ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookUpdateRequestDTO", "summary": "body", "description": "Webhook data" } } }, "description": "Webhook data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookIntegrationDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update webhook integration (org)", "tags": [ "Webhooks" ] } }, "/organizations/{organization}/invitation/{ID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Invitation ID", "in": "path", "name": "ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Revoke an organization invitation", "tags": [ "Organizations" ] } }, "/organizations/{organization}/logs/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size", "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Sort query, e.g. sort[createdAt]=desc", "in": "query", "name": "sort", "schema": { "type": "string" } }, { "description": "Filter query, e.g. filterQuery[logs.log_level][is]=error", "in": "query", "name": "filterQuery", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_LogDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List organization logs", "tags": [ "Logs" ] } }, "/organizations/{organization}/members": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "object" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List organization members", "tags": [ "Organizations" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.InviteRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Invitation" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Invite member to organization", "tags": [ "Organizations" ] } }, "/organizations/{organization}/members/{userID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "userID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Remove member from organization", "tags": [ "Organizations" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "userID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgChangeRoleRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Change member role", "tags": [ "Organizations" ] } }, "/organizations/{organization}/metrics": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ownerId": { "type": "string" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get organization metrics", "tags": [ "Organizations" ] } }, "/organizations/{organization}/pats": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.PATDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List organization access tokens", "tags": [ "Authentication" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PatCreateRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PATCreateResponseDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create organization access token", "tags": [ "Authentication" ] } }, "/organizations/{organization}/pats/{tokenID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete organization access token", "tags": [ "Authentication" ] } }, "/organizations/{organization}/policies": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Policy" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List organization policies", "tags": [ "Policies" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PolicyDTO", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PolicyDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a policy", "tags": [ "Policies" ] } }, "/organizations/{organization}/policies/{policyID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Policy ID", "in": "path", "name": "policyID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete a policy", "tags": [ "Policies" ] }, "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Policy ID", "in": "path", "name": "policyID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Policy" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get a policy", "tags": [ "Policies" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Policy ID", "in": "path", "name": "policyID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PolicyDTO", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Policy" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update a policy", "tags": [ "Policies" ] } }, "/organizations/{organization}/projects": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size", "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "description": "Search query", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-github_com_l3montree-dev_devguard_database_models_Project" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List projects", "tags": [ "Projects" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ProjectCreateRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Project" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create project", "tags": [ "Projects" ] } }, "/organizations/{organization}/projects/search/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Search query", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size", "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_ProjectDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Search projects with sub-projects and assets", "tags": [ "Projects" ] } }, "/organizations/{organization}/projects/{projectSlug}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete project", "tags": [ "Projects" ] }, "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ProjectDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get project details", "tags": [ "Projects" ] }, "patch": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ProjectPatchRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ProjectDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update project", "tags": [ "Projects" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.AssetDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List assets", "tags": [ "Assets" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetCreateRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create asset", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete asset", "tags": [ "Assets" ] }, "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get asset details", "tags": [ "Assets" ] }, "patch": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetPatchRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetDetailsWithSecretsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update asset", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/badges/{badge}/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Badge type", "in": "path", "name": "badge", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "image/svg+xml": { "schema": { "type": "string" } } }, "description": "SVG badge" } }, "summary": "Get asset badge", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/compliance": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/compliance.PolicyEvaluation" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get asset compliance", "tags": [ "Compliance" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/compliance/{policy}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Policy ID", "in": "path", "name": "policy", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compliance.PolicyEvaluation" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get policy compliance details for an asset", "tags": [ "Compliance" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/components/licenses": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "query", "name": "artifact", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/controllers.licenseResponse" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get license distribution for an asset", "tags": [ "Components" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/config-files/{config-file}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Config file ID", "in": "path", "name": "config-file", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Config file content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get asset config file", "tags": [ "Assets" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Config file ID", "in": "path", "name": "config-file", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "string" } } }, "description": "Config file content", "required": true }, "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Updated config file content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update asset config file", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/csaf": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF directory index HTML", "tags": [ "CSAF" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/csaf/white": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF TLP white directory HTML", "tags": [ "CSAF" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/csaf/white/changes.csv": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF changes CSV", "tags": [ "CSAF" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/csaf/white/index.txt": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF index file", "tags": [ "CSAF" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/csaf/white/{year}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Year", "in": "path", "name": "year", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF reports by year HTML", "tags": [ "CSAF" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/csaf/white/{year}/{version}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Year", "in": "path", "name": "year", "required": true, "schema": { "type": "string" } }, { "description": "Version filename", "in": "path", "name": "version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CSAF report", "tags": [ "CSAF" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/dependency-proxy-urls/": { "get": { "parameters": [ { "description": "organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get asset dependency proxy URLs", "tags": [ "Dependency Firewall" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/external-references": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.ExternalReferenceDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List external references for an asset", "tags": [ "ExternalReferences" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CreateExternalReferenceRequest", "summary": "request", "description": "Create request" } } }, "description": "Create request", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ExternalReferenceDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create an external reference", "tags": [ "ExternalReferences" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/external-references/sync": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Sync external sources for all artifacts of an asset version", "tags": [ "ExternalReferences" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/external-references/{url}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "URL-encoded external reference URL", "in": "path", "name": "url", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete an external reference by URL", "tags": [ "ExternalReferences" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/in-toto/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CreateInTotoLinkRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.InTotoLink" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create an in-toto link", "tags": [ "In-toto" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/in-toto/root.layout.json/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get the in-toto root layout", "tags": [ "In-toto" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/integrations/gitlab/autosetup/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Auto-setup the GitLab integration for an asset", "tags": [ "Integrations" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/logs/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size", "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Sort query, e.g. sort[createdAt]=desc", "in": "query", "name": "sort", "schema": { "type": "string" } }, { "description": "Filter query, e.g. filterQuery[logs.log_level][is]=error", "in": "query", "name": "filterQuery", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_LogDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List asset logs", "tags": [ "Logs" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/members/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List asset members", "tags": [ "Assets" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetInviteToAssetRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Invite members to asset", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/members/{userID}/": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "userID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Remove member from asset", "tags": [ "Assets" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "userID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetChangeRoleRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Change role of asset member", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/number-of-exploits/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.CVE" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get CVEs with known exploits for an asset", "tags": [ "Statistics" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/pats": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.PATDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List asset access tokens", "tags": [ "Authentication" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PatCreateRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PATCreateResponseDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create asset access token", "tags": [ "Authentication" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/pats/{tokenID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete asset access token", "tags": [ "Authentication" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/pipeline-trigger/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Trigger asset daemon pipeline", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.AssetVersionDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List asset versions", "tags": [ "Asset Versions" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "defaultBranch": { "type": "boolean" }, "name": { "type": "string" }, "tag": { "type": "boolean" } }, "title": "body", "type": "object" } } }, "description": "Request body", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetVersionDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create asset version", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete asset version", "tags": [ "Asset Versions" ] }, "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AssetVersionDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get asset version details", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/advisory/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-github_com_l3montree-dev_devguard_database_models_Advisory" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List advisories", "tags": [ "Advisories" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AdvisoryCreate", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create advisory", "tags": [ "Advisories" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/advisory/{id}/": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Advisory ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete advisory", "tags": [ "Advisories" ] }, "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Advisory ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Advisory" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get advisory details", "tags": [ "Advisories" ] }, "patch": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Advisory ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.AdvisoryUpdate", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update advisory", "tags": [ "Advisories" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/advisory/{id}/events/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Advisory ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CreateEventRequest", "summary": "event", "description": "Event" } } }, "description": "Event", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create advisory event", "tags": [ "Advisories" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/affected-components/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "query", "name": "artifactName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.DependencyVulnDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get affected components and dependency vulnerabilities", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifact-root-nodes/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get information sources of the root nodes for each artifact", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.ArtifactDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List artifacts of an asset version", "tags": [ "Asset Versions" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.ArtifactRequest", "summary": "body", "description": "Artifact data" } } }, "description": "Artifact data", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ArtifactDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create artifact", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete artifact", "tags": [ "Artifacts" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.ArtifactRequest", "summary": "body", "description": "Artifact data" } } }, "description": "Artifact data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.ArtifactUpdateResponse" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update artifact", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/badges/{badge}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Badge type", "in": "path", "name": "badge", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "image/svg+xml": { "schema": { "type": "string" } } }, "description": "SVG badge" } }, "summary": "Get asset badge", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/csaf.json/": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "CSAF advisory in JSON format" } }, "summary": "Get an aggregated CSAF VEX for all of the artifact's vulnerabilities", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/openvex.json/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OpenVEX document in JSON format" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get VEX in OpenVEX JSON format", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/sbom.json/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "CycloneDX BOM in JSON format" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get SBOM in JSON format", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/sbom.pdf/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "type": "string" } } }, "description": "SBOM as PDF" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get SBOM as PDF", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/sbom.xml/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/xml": { "schema": { "type": "string" } } }, "description": "CycloneDX BOM in XML format" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get SBOM in XML format", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/sync-external-sources": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Sync external sources for a single artifact", "tags": [ "ExternalReferences" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/vex.json/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "CycloneDX VEX in JSON format" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get VEX in JSON format", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/vex.xml/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/xml": { "schema": { "type": "string" } } }, "description": "CycloneDX VEX in XML format" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get VEX in XML format", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/artifacts/{artifactName}/vulnerability-report.pdf/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "type": "string" } } }, "description": "Vulnerability report as PDF" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get vulnerability report as PDF", "tags": [ "Artifacts" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/attestations": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Attestation" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List attestations", "tags": [ "Attestations" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/compliance": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/compliance.PolicyEvaluation" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get asset version compliance", "tags": [ "Compliance" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/compliance-postures": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_CompliancePostureWithControlDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List compliance postures paged", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/compliance-postures/components/{statementID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Statement ID", "in": "path", "name": "statementID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete a compliance statement", "tags": [ "Compliance Components" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Statement ID", "in": "path", "name": "statementID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.statementPayload", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ComplianceComponentImplementsControlStatementDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update a compliance statement", "tags": [ "Compliance Components" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/compliance-postures/oscal": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get OSCAL system security plan", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/compliance-postures/stats": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureStatsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get compliance posture stats", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/compliance-postures/{frameworkControlID}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Framework Control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureWithDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get compliance posture for a framework control", "tags": [ "Compliance Postures" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Framework Control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "justification": { "type": "string" }, "status": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "Event data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureWithDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a compliance posture event", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/compliance-postures/{frameworkControlID}/components/{complianceComponentID}": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Framework control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } }, { "description": "Compliance component ID", "in": "path", "name": "complianceComponentID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.statementPayload", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ComplianceComponentImplementsControlStatementDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a compliance statement for a component", "tags": [ "Compliance Components" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/compliance/{policy}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Policy ID", "in": "path", "name": "policy", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compliance.PolicyEvaluation" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get policy compliance details for an asset version", "tags": [ "Compliance" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/components": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_ComponentDependencyDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List components paged", "tags": [ "Components" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/components/licenses": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "query", "name": "artifact", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/controllers.licenseResponse" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get license distribution for an asset version", "tags": [ "Components" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/components/licenses/refresh/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "query", "name": "artifactName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Refetch license information for all components", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/dependency-graph/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "query", "name": "artifactName", "schema": { "type": "string" } }, { "description": "Info source origin", "in": "query", "name": "origin", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transformer.MinimalTree" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get minimal dependency graph tree", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/dependency-vulns": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Flat list flag", "in": "query", "name": "flat", "schema": { "type": "string" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List dependency vulnerabilities", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/dependency-vulns/batch": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.BatchDependencyVulnStatus", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.DetailedDependencyVulnDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Batch create vulnerability events", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/dependency-vulns/sync": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Sync dependency vulnerabilities with third party integrations", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/dependency-vulns/{dependencyVulnID}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Vulnerability ID", "in": "path", "name": "dependencyVulnID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedDependencyVulnWithRelationsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get dependency vulnerability details", "tags": [ "Vulnerabilities" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Vulnerability ID", "in": "path", "name": "dependencyVulnID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CreateEventRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedDependencyVulnDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create vulnerability event", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/dependency-vulns/{dependencyVulnID}/events": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Dependency vulnerability ID", "in": "path", "name": "dependencyVulnID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.VulnEventDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List events for a vulnerability", "tags": [ "Vulnerability Events" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/dependency-vulns/{dependencyVulnID}/hints": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Vulnerability ID", "in": "path", "name": "dependencyVulnID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get hints for a dependency vulnerability", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/dependency-vulns/{dependencyVulnID}/mitigate": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Vulnerability ID", "in": "path", "name": "dependencyVulnID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedDependencyVulnDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Mitigate a dependency vulnerability", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/events": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size", "in": "query", "name": "pageSize", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_VulnEventDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List events for an asset version", "tags": [ "Vulnerability Events" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/events/{eventID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Event ID", "in": "path", "name": "eventID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete an event", "tags": [ "Vulnerability Events" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/first-party-vulns": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List first-party vulnerabilities by asset version", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/first-party-vulns/batch": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.BatchFirstPartyVulnStatus", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.DetailedFirstPartyVulnDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Batch update first-party vulnerability states", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/first-party-vulns/{firstPartyVulnID}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Vulnerability ID", "in": "path", "name": "firstPartyVulnID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedFirstPartyVulnDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get first-party vulnerability details", "tags": [ "Vulnerabilities" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Vulnerability ID", "in": "path", "name": "firstPartyVulnID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.FirstPartyVulnStatus", "summary": "body", "description": "Event data" } } }, "description": "Event data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedFirstPartyVulnDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create first-party vulnerability event", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/first-party-vulns/{firstPartyVulnID}/events": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Dependency vulnerability ID", "in": "path", "name": "dependencyVulnID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.VulnEventDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List events for a vulnerability", "tags": [ "Vulnerability Events" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/first-party-vulns/{firstPartyVulnID}/mitigate": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Vulnerability ID", "in": "path", "name": "firstPartyVulnID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "justification": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedFirstPartyVulnDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Mitigate a first-party vulnerability", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/in-toto/{supplyChainID}/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Supply chain ID", "in": "path", "name": "supplyChainID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Download in-toto links for a supply chain", "tags": [ "In-toto" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/license-risks": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List license risks", "tags": [ "License Risk" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "componentPurl": { "type": "string" }, "finalLicenseDecision": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.LicenseRisk" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create license risk", "tags": [ "License Risk" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/license-risks/{licenseRiskID}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "License risk ID", "in": "path", "name": "licenseRiskID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedLicenseRiskDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get license risk details", "tags": [ "License Risk" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "License risk ID", "in": "path", "name": "licenseRiskID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.LicenseRiskStatus", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedLicenseRiskDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a license risk event", "tags": [ "License Risk" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/license-risks/{licenseRiskID}/final-license-decision": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "License risk ID", "in": "path", "name": "licenseRiskID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.MakeFinalLicenseDecisionRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedLicenseRiskDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Make final license decision", "tags": [ "License Risk" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/license-risks/{licenseRiskID}/mitigate": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "License risk ID", "in": "path", "name": "licenseRiskID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.DetailedLicenseRiskDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Mitigate a license risk", "tags": [ "License Risk" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/make-default/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.AssetVersion" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Mark asset version as the default branch", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/metrics": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "query", "name": "artifactName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get asset version metrics", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/path-to-component/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Component pURL", "in": "query", "name": "purl", "schema": { "type": "string" } }, { "description": "Artifact name", "in": "query", "name": "artifactName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get dependency paths leading to a component pURL", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/sarif.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get first-party vulnerabilities as SARIF", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/sbom.json/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get SBOM as CycloneDX JSON", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/stats/average-fixing-time/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Restrict results to a specific artifact", "in": "query", "name": "artifactName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.RemediationTimeAverages" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get average fixing times for an asset version", "tags": [ "Statistics" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/stats/component-risk/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Restrict results to a specific artifact", "in": "query", "name": "artifactName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get component risk distribution for an asset version", "tags": [ "Statistics" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/stats/risk-history/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Restrict results to a specific artifact", "in": "query", "name": "artifactName", "schema": { "type": "string" } }, { "description": "Start date (YYYY-MM-DD)", "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "description": "End date (YYYY-MM-DD)", "in": "query", "name": "end", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.RiskHistoryDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get risk history for an asset version", "tags": [ "Statistics" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/refs/{assetVersionSlug}/vex.json/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get VEX as CycloneDX JSON", "tags": [ "Asset Versions" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/sbom-file": { "post": { "parameters": [ { "description": "Origin", "in": "header", "name": "X-Origin", "schema": { "type": "string" } }, { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "SBOM file", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "description": "SBOM file", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ScanResponse" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Scan SBOM file", "tags": [ "Scanning" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/secrets/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get asset secrets", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/signing-key/": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Attach signing key to asset", "tags": [ "Assets" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/stats/risk-history/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Restrict results to a specific artifact", "in": "query", "name": "artifactName", "schema": { "type": "string" } }, { "description": "Start date (YYYY-MM-DD)", "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "description": "End date (YYYY-MM-DD)", "in": "query", "name": "end", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.RiskHistoryWithVersionDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get risk history for an asset across all asset versions", "tags": [ "Statistics" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/vex-rules": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Page number (default: 1)", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size (default: 10, max: 100)", "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "description": "Search term for CVE ID or justification", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/dtos.VEXRuleDTO" }, "type": "array" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List VEX rules for an asset", "tags": [ "VEXRules" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CreateVEXRuleRequest", "summary": "body", "description": "Rule data" } } }, "description": "Rule data", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.VEXRuleDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a VEX rule", "tags": [ "VEXRules" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/vex-rules/recommendations": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/dtos.VexRuleRecommendation" }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get crowdsourced VEX recommendations for all vulns of an asset", "tags": [ "CrowdsourcedVexing" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/vex-rules/recommendations/{dependencyVulnID}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Dependency vuln ID", "in": "path", "name": "dependencyVulnID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.VexRuleRecommendation" } } }, "description": "OK" }, "204": { "description": "No recommendation available" }, "404": { "description": "Dependency vulnerability not found" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get a crowdsourced VEX recommendation for a dependency vuln", "tags": [ "CrowdsourcedVexing" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/vex-rules/test": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.TestVEXRulesRequest", "summary": "body", "description": "CEL expressions to test" } } }, "description": "CEL expressions to test", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "integer" }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Test VEX rules against the vulnerabilities they'd apply to", "tags": [ "VEXRules" ] } }, "/organizations/{organization}/projects/{projectSlug}/assets/{assetSlug}/vex-rules/{ruleId}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Rule ID", "in": "path", "name": "ruleId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete a VEX rule", "tags": [ "VEXRules" ] }, "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Rule ID", "in": "path", "name": "ruleId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.VEXRuleDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get a VEX rule", "tags": [ "VEXRules" ] } }, "/organizations/{organization}/projects/{projectSlug}/compliance": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "array" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get project compliance", "tags": [ "Compliance" ] } }, "/organizations/{organization}/projects/{projectSlug}/compliance-postures": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_CompliancePostureWithControlDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List compliance postures paged", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/projects/{projectSlug}/compliance-postures/components/{statementID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Statement ID", "in": "path", "name": "statementID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete a compliance statement", "tags": [ "Compliance Components" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Statement ID", "in": "path", "name": "statementID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.statementPayload", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ComplianceComponentImplementsControlStatementDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update a compliance statement", "tags": [ "Compliance Components" ] } }, "/organizations/{organization}/projects/{projectSlug}/compliance-postures/oscal": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get OSCAL system security plan", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/projects/{projectSlug}/compliance-postures/stats": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureStatsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get compliance posture stats", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/projects/{projectSlug}/compliance-postures/{frameworkControlID}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Framework Control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureWithDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get compliance posture for a framework control", "tags": [ "Compliance Postures" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Framework Control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "justification": { "type": "string" }, "status": { "type": "string" } }, "title": "body", "type": "object" } } }, "description": "Event data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CompliancePostureWithDetailsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a compliance posture event", "tags": [ "Compliance Postures" ] } }, "/organizations/{organization}/projects/{projectSlug}/compliance-postures/{frameworkControlID}/components/{complianceComponentID}": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Framework control ID", "in": "path", "name": "frameworkControlID", "required": true, "schema": { "type": "string" } }, { "description": "Compliance component ID", "in": "path", "name": "complianceComponentID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.statementPayload", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ComplianceComponentImplementsControlStatementDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create a compliance statement for a component", "tags": [ "Compliance Components" ] } }, "/organizations/{organization}/projects/{projectSlug}/components": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_ComponentOccurrenceDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Search component occurrences within a project", "tags": [ "Components" ] } }, "/organizations/{organization}/projects/{projectSlug}/config-files/{config-file}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Config file ID", "in": "path", "name": "config-file", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Config file content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get project config file", "tags": [ "Projects" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Config file ID", "in": "path", "name": "config-file", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "string" } } }, "description": "Config file content", "required": true }, "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Updated config file content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update project config file", "tags": [ "Projects" ] } }, "/organizations/{organization}/projects/{projectSlug}/dependency-proxy-urls/": { "get": { "parameters": [ { "description": "organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get project dependency proxy URLs", "tags": [ "Dependency Firewall" ] } }, "/organizations/{organization}/projects/{projectSlug}/dependency-vulns": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List dependency vulnerabilities by project", "tags": [ "Vulnerabilities" ] } }, "/organizations/{organization}/projects/{projectSlug}/external/{providerID}": { "get": { "description": "Returns the full tree of projects, sub-projects, assets, asset versions and artifacts that were dynamically created by an external inventory provider (e.g. k8s-devguard-image-inventory) for the given providerID.", "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "External provider ID", "in": "path", "name": "providerID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.ProjectExternalEntityTree" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List externally managed project/asset tree", "tags": [ "External Entity" ] }, "post": { "description": "Called by external inventory providers (e.g. k8s-devguard-image-inventory) to upsert or delete a dynamically managed project hierarchy. On verb=update, creates or updates the project, sub-project, asset, asset version and artifact, then processes the supplied CycloneDX SBOM and triggers a vulnerability scan. On verb=delete, removes the artifact/asset-version/asset/project entries cascading upward as long as no other data references them.", "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "External provider ID", "in": "path", "name": "providerID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ExternalSubprojectRequestDTO", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Sync or delete an externally managed project/asset tree", "tags": [ "External Entity" ] } }, "/organizations/{organization}/projects/{projectSlug}/integrations/webhook/test": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookTestRequestDTO", "summary": "body", "description": "Test webhook data" } } }, "description": "Test webhook data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "payloadType": { "type": "string" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Test webhook integration (project)", "tags": [ "Webhooks" ] } }, "/organizations/{organization}/projects/{projectSlug}/integrations/webhook/test-and-save": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookCreateRequestDTO", "summary": "body", "description": "Webhook data" } } }, "description": "Webhook data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookIntegrationDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create webhook integration (project)", "tags": [ "Webhooks" ] } }, "/organizations/{organization}/projects/{projectSlug}/integrations/webhook/{id}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Webhook ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete webhook integration (project)", "tags": [ "Webhooks" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Webhook ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookUpdateRequestDTO", "summary": "body", "description": "Webhook data" } } }, "description": "Webhook data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.WebhookIntegrationDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update webhook integration (project)", "tags": [ "Webhooks" ] } }, "/organizations/{organization}/projects/{projectSlug}/logs/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Page size", "in": "query", "name": "pageSize", "schema": { "type": "integer" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Sort query, e.g. sort[createdAt]=desc", "in": "query", "name": "sort", "schema": { "type": "string" } }, { "description": "Filter query, e.g. filterQuery[logs.log_level][is]=error", "in": "query", "name": "filterQuery", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_LogDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List project logs", "tags": [ "Logs" ] } }, "/organizations/{organization}/projects/{projectSlug}/members": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.UserDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List project members", "tags": [ "Projects" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ProjectInviteRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Invite members to project", "tags": [ "Projects" ] } }, "/organizations/{organization}/projects/{projectSlug}/members/{userID}/": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "userID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Remove member from project", "tags": [ "Projects" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "User ID", "in": "path", "name": "userID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ProjectChangeRoleRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Change member role in project", "tags": [ "Projects" ] } }, "/organizations/{organization}/projects/{projectSlug}/pats": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.PATDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List project access tokens", "tags": [ "Authentication" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PatCreateRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PATCreateResponseDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create project access token", "tags": [ "Authentication" ] } }, "/organizations/{organization}/projects/{projectSlug}/pats/{tokenID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete project access token", "tags": [ "Authentication" ] } }, "/organizations/{organization}/projects/{projectSlug}/policies": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.Policy" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List project policies", "tags": [ "Policies" ] } }, "/organizations/{organization}/projects/{projectSlug}/policies/{policyID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Policy ID", "in": "path", "name": "policyID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Disable a policy for a project", "tags": [ "Policies" ] }, "put": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Policy ID", "in": "path", "name": "policyID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Enable a policy for a project", "tags": [ "Policies" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Search term", "in": "query", "name": "search", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_ReleaseDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List releases", "tags": [ "Releases" ] }, "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ReleaseCreateRequest", "summary": "body", "description": "Release data" } } }, "description": "Release data", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ReleaseDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Create release", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/candidates": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "query", "name": "releaseID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CandidatesResponseDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List release candidates", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete release", "tags": [ "Releases" ] }, "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ReleaseDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get release details", "tags": [ "Releases" ] }, "patch": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ReleasePatchRequest", "summary": "body", "description": "Release data" } } }, "description": "Release data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ReleaseDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Update release", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/candidates": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "query", "name": "releaseID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.CandidatesResponseDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List release candidates", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/csaf.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": null, "summary": "Get release VEX as CSAF", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/items": { "post": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ReleaseItemDTO", "summary": "body", "description": "Release item data" } } }, "description": "Release item data", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ReleaseItemDTO" } } }, "description": "Created" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Add item to release", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/items/{itemID}": { "delete": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } }, { "description": "Item ID", "in": "path", "name": "itemID", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Remove item from release", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/openvex.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": null, "summary": "Get release VEX as OpenVEX", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/sbom.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get release SBOM as JSON", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/sbom.xml": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get release SBOM as XML", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/stats/average-fixing-time/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.RemediationTimeAverages" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get average remediation times for a release", "tags": [ "Statistics" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/stats/risk-history/": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } }, { "description": "Start date (YYYY-MM-DD)", "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "description": "End date (YYYY-MM-DD)", "in": "query", "name": "end", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.RiskHistoryDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get risk history for a release", "tags": [ "Statistics" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/vex.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get release VEX as JSON", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/releases/{releaseID}/vex.xml": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get release VEX as XML", "tags": [ "Releases" ] } }, "/organizations/{organization}/projects/{projectSlug}/resources": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Search query for filtering sub-projects and assets", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Only list children of this project ID", "in": "query", "name": "parentId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_shared.Paged-dtos_ProjectAssetDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List sub-projects and assets", "tags": [ "Projects" ] } }, "/organizations/{organization}/settings": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgSettingsDTO" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get organization admin settings", "tags": [ "Organizations" ] } }, "/organizations/{organization}/stats/vuln-statistics/": { "get": { "description": "Returns aggregated security statistics for an organization, including vulnerability distribution, top vulnerable projects/assets/artifacts, most used components, common CVEs, risk history, remediation metrics, and ecosystem usage. All queries are executed in parallel.", "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Max number of top vulnerable projects/assets/artifacts to return (default: 5)", "in": "query", "name": "orgComponentsLimit", "schema": { "type": "integer" } }, { "description": "Max number of top CVEs to return (default: 5)", "in": "query", "name": "topCVEsLimit", "schema": { "type": "integer" } }, { "description": "Max number of top components to return (default: 5)", "in": "query", "name": "topComponentsLimit", "schema": { "type": "integer" } }, { "description": "Max number of top ecosystems to return (default: 5)", "in": "query", "name": "topEcosystemsLimit", "schema": { "type": "integer" } }, { "description": "Bypass the 15 minute statistics cache", "in": "query", "name": "forceRefresh", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.OrgOverview" } } }, "description": "OK" } }, "summary": "Get organization statistics overview", "tags": [ "Organizations" ] } }, "/organizations/{organization}/trigger-sync": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "organization is not an external entity provider" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] } ], "summary": "Trigger a sync for the given org", "tags": [ "Organizations" ] } }, "/pats": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.PATDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "List personal access tokens", "tags": [ "Authentication" ] }, "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PatCreateRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createdAt": { "type": "string" }, "description": { "type": "string" }, "fingerprint": { "type": "string" }, "id": { "type": "string" }, "pubKey": { "type": "string" }, "scopes": { "type": "string" }, "userID": { "type": "string" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] } ], "summary": "Create personal access token", "tags": [ "Authentication" ] } }, "/pats/revoke-by-private-key": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.RevokeByPrivateKeyRequest", "summary": "body", "description": "Request body" } } }, "description": "Request body", "required": true }, "responses": { "200": { "description": "OK" } }, "summary": "Revoke PAT by private key", "tags": [ "Authentication" ] } }, "/pats/{tokenID}": { "delete": { "parameters": [ { "description": "Token ID", "in": "path", "name": "tokenID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Delete personal access token", "tags": [ "Authentication" ] } }, "/public/{assetID}/refs/{assetVersionSlug}/artifacts/{artifactName}/badges/{badge}": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Badge type", "in": "path", "name": "badge", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "image/svg+xml": { "schema": { "type": "string" } } }, "description": "SVG badge" } }, "summary": "Get asset badge", "tags": [ "Assets" ] } }, "/public/{assetID}/refs/{assetVersionSlug}/artifacts/{artifactName}/csaf.json": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "CSAF advisory in JSON format" } }, "summary": "Get an aggregated CSAF VEX for all of the artifact's vulnerabilities", "tags": [ "Artifacts" ] } }, "/public/{assetID}/refs/{assetVersionSlug}/artifacts/{artifactName}/openvex.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OpenVEX document in JSON format" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get VEX in OpenVEX JSON format", "tags": [ "Artifacts" ] } }, "/public/{assetID}/refs/{assetVersionSlug}/artifacts/{artifactName}/sbom.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "CycloneDX BOM in JSON format" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get SBOM in JSON format", "tags": [ "Artifacts" ] } }, "/public/{assetID}/refs/{assetVersionSlug}/artifacts/{artifactName}/vex.json": { "get": { "parameters": [ { "description": "Organization slug", "in": "path", "name": "organization", "required": true, "schema": { "type": "string" } }, { "description": "Project slug", "in": "path", "name": "projectSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset slug", "in": "path", "name": "assetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Asset version slug", "in": "path", "name": "assetVersionSlug", "required": true, "schema": { "type": "string" } }, { "description": "Artifact name", "in": "path", "name": "artifactName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "CycloneDX VEX in JSON format" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Get VEX in JSON format", "tags": [ "Artifacts" ] } }, "/renovate/recommendation": { "get": { "parameters": [ { "description": "Package name", "in": "query", "name": "packageName", "required": true, "schema": { "type": "string" } }, { "description": "Current version value", "in": "query", "name": "currentValue", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.Recommendation" } } }, "description": "OK" } }, "summary": "Get recommended fixed version for a package", "tags": [ "Vulnerabilities" ] } }, "/resolve": { "get": { "description": "Resolves an organization, project or asset UUID to the slugs the frontend needs to build a human readable URL. Exactly one of the query parameters must be set.", "parameters": [ { "description": "Organization ID", "in": "query", "name": "orgId", "schema": { "type": "string" } }, { "description": "Project ID", "in": "query", "name": "projectId", "schema": { "type": "string" } }, { "description": "Asset ID", "in": "query", "name": "assetId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.PermalinkResponse" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Resolve a permalink", "tags": [ "Organizations" ] } }, "/sarif-scan": { "post": { "deprecated": true, "parameters": [ { "description": "Asset version name", "in": "header", "name": "X-Asset-Ref", "schema": { "type": "string" } }, { "description": "Tag flag", "in": "header", "name": "X-Tag", "schema": { "type": "string" } }, { "description": "Default branch", "in": "header", "name": "X-Asset-Default-Branch", "schema": { "type": "string" } }, { "description": "Scanner ID", "in": "header", "name": "X-Scanner", "required": true, "schema": { "type": "string" } }, { "description": "Asset name as \u003corganization\u003e/\u003cproject\u003e/\u003casset\u003e", "in": "header", "name": "X-Asset-Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "SARIF scan result", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.FirstPartyScanResponse" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Scan for first-party vulnerabilities", "tags": [ "Scanning" ] } }, "/sarif-scan-unauthenticated": { "post": { "deprecated": true, "parameters": [ { "description": "Scanner ID", "in": "header", "name": "X-Scanner", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "SARIF scan result", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.FirstPartyScanResponse" } } }, "description": "OK" } }, "summary": "Scan for first-party vulnerabilities without authentication (scan-only, results are not saved)", "tags": [ "Scanning" ] } }, "/scan": { "post": { "deprecated": true, "parameters": [ { "description": "Asset version name", "in": "header", "name": "X-Asset-Ref", "schema": { "type": "string" } }, { "description": "Artifact name", "in": "header", "name": "X-Artifact-Name", "schema": { "type": "string" } }, { "description": "Tag flag", "in": "header", "name": "X-Tag", "schema": { "type": "string" } }, { "description": "Default branch", "in": "header", "name": "X-Asset-Default-Branch", "schema": { "type": "string" } }, { "description": "Origin", "in": "header", "name": "X-Origin", "schema": { "type": "string" } }, { "description": "Scanner ID", "in": "header", "name": "X-Scanner", "schema": { "type": "string" } }, { "description": "Asset name as \u003corganization\u003e/\u003cproject\u003e/\u003casset\u003e", "in": "header", "name": "X-Asset-Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "CycloneDX SBOM", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ScanResponse" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Scan for dependency vulnerabilities", "tags": [ "Scanning" ] } }, "/scan-unauthenticated": { "post": { "deprecated": true, "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "CycloneDX SBOM", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dtos.ScanResponse" } } }, "description": "OK" } }, "summary": "Scan for dependency vulnerabilities without authentication (scan-only, results are not saved)", "tags": [ "Scanning" ] } }, "/trigger-sync": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/dtos.OrgDTO" }, "type": "array" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] } ], "summary": "Trigger a sync for the current session's org", "tags": [ "Organizations" ] } }, "/v2": { "head": { "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "OCI Distribution Spec v2 version check", "tags": [ "Dependency Firewall" ] } }, "/v2/": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "OCI Distribution Spec v2 version check", "tags": [ "Dependency Firewall" ] } }, "/v2/{registry}/{image}/blobs/{digest}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "blob digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image blob download", "tags": [ "Dependency Firewall" ] }, "head": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "blob digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image blob download", "tags": [ "Dependency Firewall" ] } }, "/v2/{registry}/{image}/manifests/{reference}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "tag or digest", "in": "path", "name": "reference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image manifest fetch", "tags": [ "Dependency Firewall" ] }, "head": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "tag or digest", "in": "path", "name": "reference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image manifest fetch", "tags": [ "Dependency Firewall" ] } }, "/v2/{registry}/{image}/referrers/{digest}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "subject digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image referrers list", "tags": [ "Dependency Firewall" ] } }, "/v2/{registry}/{image}/tags/list": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image tags list", "tags": [ "Dependency Firewall" ] } }, "/v2/{registry}/{namespace}/{image}/blobs/{digest}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "blob digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image blob download", "tags": [ "Dependency Firewall" ] }, "head": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "blob digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image blob download", "tags": [ "Dependency Firewall" ] } }, "/v2/{registry}/{namespace}/{image}/manifests/{reference}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "tag or digest", "in": "path", "name": "reference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image manifest fetch", "tags": [ "Dependency Firewall" ] }, "head": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "tag or digest", "in": "path", "name": "reference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image manifest fetch", "tags": [ "Dependency Firewall" ] } }, "/v2/{registry}/{namespace}/{image}/referrers/{digest}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "subject digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image referrers list", "tags": [ "Dependency Firewall" ] } }, "/v2/{registry}/{namespace}/{image}/tags/list": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image tags list", "tags": [ "Dependency Firewall" ] } }, "/v2/{secret}/{registry}/{namespace}/{image}/blobs/{digest}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "blob digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image blob download", "tags": [ "Dependency Firewall" ] }, "head": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "blob digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image blob download", "tags": [ "Dependency Firewall" ] } }, "/v2/{secret}/{registry}/{namespace}/{image}/manifests/{reference}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "tag or digest", "in": "path", "name": "reference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image manifest fetch", "tags": [ "Dependency Firewall" ] }, "head": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "tag or digest", "in": "path", "name": "reference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image manifest fetch", "tags": [ "Dependency Firewall" ] } }, "/v2/{secret}/{registry}/{namespace}/{image}/referrers/{digest}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "subject digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image referrers list", "tags": [ "Dependency Firewall" ] } }, "/v2/{secret}/{registry}/{namespace}/{image}/tags/list": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image tags list", "tags": [ "Dependency Firewall" ] } }, "/v2/{secret}/{registry}/{ns1}/{ns2}/{image}/blobs/{digest}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "blob digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image blob download", "tags": [ "Dependency Firewall" ] }, "head": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "blob digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "file" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image blob download", "tags": [ "Dependency Firewall" ] } }, "/v2/{secret}/{registry}/{ns1}/{ns2}/{image}/manifests/{reference}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "tag or digest", "in": "path", "name": "reference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image manifest fetch", "tags": [ "Dependency Firewall" ] }, "head": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "tag or digest", "in": "path", "name": "reference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image manifest fetch", "tags": [ "Dependency Firewall" ] } }, "/v2/{secret}/{registry}/{ns1}/{ns2}/{image}/referrers/{digest}": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } }, { "description": "subject digest", "in": "path", "name": "digest", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image referrers list", "tags": [ "Dependency Firewall" ] } }, "/v2/{secret}/{registry}/{ns1}/{ns2}/{image}/tags/list": { "get": { "parameters": [ { "description": "dependency proxy secret", "in": "path", "name": "secret", "schema": { "type": "string" } }, { "description": "registry hostname", "in": "path", "name": "registry", "required": true, "schema": { "type": "string" } }, { "description": "image namespace", "in": "path", "name": "namespace", "schema": { "type": "string" } }, { "description": "image name", "in": "path", "name": "image", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } }, "description": "OK" } }, "security": [ { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Proxy OCI image tags list", "tags": [ "Dependency Firewall" ] } }, "/verify-supply-chain/": { "get": { "responses": { "200": { "description": "OK" } }, "summary": "Verify a supply chain attestation", "tags": [ "In-toto" ] } }, "/vex": { "post": { "parameters": [ { "description": "Tag flag", "in": "header", "name": "X-Tag", "schema": { "type": "string" } }, { "description": "Default branch", "in": "header", "name": "X-Asset-Default-Branch", "schema": { "type": "string" } }, { "description": "Origin", "in": "header", "name": "X-Origin", "schema": { "type": "string" } }, { "description": "Asset name as \u003corganization\u003e/\u003cproject\u003e/\u003casset\u003e", "in": "header", "name": "X-Asset-Name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "text/plain": { "schema": { "title": "body", "type": "object" } } }, "description": "CycloneDX VEX BOM", "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] }, { "BearerAuth": [] } ], "summary": "Upload VEX document", "tags": [ "Scanning" ] } }, "/vulndb": { "get": { "description": "Get a paginated list of CVEs with optional filtering and sorting", "parameters": [ { "description": "Page number", "in": "query", "name": "page", "schema": { "type": "integer" } }, { "description": "Number of items per page", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Sort by field, e.g. 'sort[cve]=asc", "in": "query", "name": "sort", "schema": { "type": "string" } }, { "description": "Filter query, e.g. 'filterQuery[cvss][is greater than]=4'", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "Confidentiality Requirements (low, medium, high), default is medium", "in": "query", "name": "confidentialityRequirements", "schema": { "type": "string" } }, { "description": "Integrity Requirements (low, medium, high), default is medium", "in": "query", "name": "integrityRequirements", "schema": { "type": "string" } }, { "description": "Availability Requirements (low, medium, high), default is medium", "in": "query", "name": "availabilityRequirements", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.CVE" }, "type": "array" }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } } }, "description": "A paginated list of CVEs" }, "500": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "description": "Internal server error" } }, "summary": "List all CVEs with pagination", "tags": [ "CVE Database", "CVE" ] } }, "/vulndb/cve-ecosystem-distribution": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "integer" }, "type": "object" } } }, "description": "OK" } }, "summary": "Get the CVE distribution across ecosystems", "tags": [ "VulnDB" ] } }, "/vulndb/list-ids-by-creation-date": { "get": { "parameters": [ { "description": "Offset to start fetching data from", "in": "query", "name": "offset", "schema": { "type": "integer" } }, { "description": "Maximum number of entries to return", "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "createdAt": { "type": "string" }, "cve": { "type": "string" }, "datePublished": { "type": "string" } }, "type": "object" }, "type": "array" }, "total": { "type": "integer" } }, "type": "object" } } }, "description": "OK" } }, "summary": "List CVE IDs sorted by creation date", "tags": [ "VulnDB" ] } }, "/vulndb/purl-inspect/{purl}": { "get": { "description": "Analyze a given PURL, determine its match context, and return affected components and related vulnerabilities", "parameters": [ { "description": "Package URL (PURL) to inspect", "in": "path", "name": "purl", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/controllers.PURLInspectResponse" } } }, "description": "Inspection result including PURL, match context, affected components, and vulnerabilities" }, "400": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "description": "Invalid PURL provided" }, "500": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "description": "Internal server error" } }, "summary": "Inspect a package URL (PURL) for vulnerabilities", "tags": [ "VulnDB" ] } }, "/vulndb/{cveID}/": { "get": { "description": "Retrieve details of a specific CVE by its ID, including risk and vector calculations", "parameters": [ { "description": "CVE ID", "in": "path", "name": "cveID", "required": true, "schema": { "type": "string" } }, { "description": "Confidentiality Requirements (low, medium, high), default is medium", "in": "query", "name": "confidentialityRequirements", "schema": { "type": "string" } }, { "description": "Integrity Requirements (low, medium, high), default is medium", "in": "query", "name": "integrityRequirements", "schema": { "type": "string" } }, { "description": "Availability Requirements (low, medium, high), default is medium", "in": "query", "name": "availabilityRequirements", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/github_com_l3montree-dev_devguard_database_models.CVE" } } }, "description": "Details of the specified CVE\" and optional advisories" }, "500": { "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } }, "description": "Internal server error" } }, "summary": "Get a specific CVE by ID", "tags": [ "CVE Database", "CVE" ] } }, "/webhook": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "OK" } }, "summary": "Handle incoming third-party integration webhook", "tags": [ "Integrations" ] } }, "/whoami": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ownerID": { "type": "string" }, "ownerType": { "type": "string" } }, "type": "object" } } }, "description": "OK" } }, "security": [ { "CookieAuth": [] }, { "PATAuth": [] } ], "summary": "Get current session info", "tags": [ "Authentication" ] } } }, "openapi": "3.1.0", "servers": [ { "description": "Development server", "url": "{scheme}://{host}:{port}/api/v1", "variables": { "host": { "default": "localhost" }, "port": { "default": "8080" }, "scheme": { "default": "http", "enum": [ "http", "https" ] } } }, { "description": "Production server", "url": "https://api.devguard.org/api/v1" } ] }