Skip to content

Latest commit

 

History

History
173 lines (101 loc) · 9.08 KB

ts-defs-definitions-config.md

File metadata and controls

173 lines (101 loc) · 9.08 KB

Config Schema

https://github.com/ossf-cve-benchmark/ossf-cve-benchmark/schemas/ts-defs.schema.json#/definitions/DriverInputs/properties/config

A configuration object.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Forbidden none ts-defs.schema.json*

config Type

object (Config)

Config Properties

Property Type Required Nullable Defined by
bcves string Optional cannot be null Generated schema types from src/persistent-types.ts
canonical-repositories-root string Optional cannot be null Generated schema types from src/persistent-types.ts
config-file string Optional cannot be null Generated schema types from src/persistent-types.ts
export string Optional cannot be null Generated schema types from src/persistent-types.ts
reports string Optional cannot be null Generated schema types from src/persistent-types.ts
results string Optional cannot be null Generated schema types from src/persistent-types.ts
sources string Optional cannot be null Generated schema types from src/persistent-types.ts
tools object Optional cannot be null Generated schema types from src/persistent-types.ts

bcves

This file contains the types used for persistent data in this project: most notably the CVE benchmark data and analysis results for them.

This file should not contain types for values that are not going to be persisted.

JSON schemas and associated documentation will be generated from this file, so everything ought to be documented thoroughly.

bcves

bcves Type

string

canonical-repositories-root

The location where canonical repositories exists for each CVE as <root>/<CVE>.git.

canonical-repositories-root

canonical-repositories-root Type

string

config-file

The configuration file that defines (some of) these values.

config-file

config-file Type

string

export

The file that is exported to.

export

export Type

string

reports

This file contains the types used for persistent data in this project: most notably the CVE benchmark data and analysis results for them.

This file should not contain types for values that are not going to be persisted.

JSON schemas and associated documentation will be generated from this file, so everything ought to be documented thoroughly.

reports

reports Type

string

results

This file contains the types used for persistent data in this project: most notably the CVE benchmark data and analysis results for them.

This file should not contain types for values that are not going to be persisted.

JSON schemas and associated documentation will be generated from this file, so everything ought to be documented thoroughly.

results

results Type

string

sources

This file contains the types used for persistent data in this project: most notably the CVE benchmark data and analysis results for them.

This file should not contain types for values that are not going to be persisted.

JSON schemas and associated documentation will be generated from this file, so everything ought to be documented thoroughly.

sources

sources Type

string

tools

The configurations of the analysis tool drivers.

tools

tools Type

object (Details)