schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
datahub_ingestion_schema.json
include_field_null_count
Whether to profile for the number of nulls for each column.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_min_value
Whether to profile for the min value of numeric columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_max_value
Whether to profile for the max value of numeric columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
operation_config
Experimental feature. To specify operation configs.
{"allOf": [{}]}
datahub_ingestion_schema.json
aws_config
AWS configuration
{"allOf": [{}]}
datahub_ingestion_schema.json
use_s3_bucket_tags
Whether or not to create tags in datahub from the s3 bucket
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
use_s3_object_tags
# Whether or not to create tags in datahub from the s3 object
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
hmac_access_id
Access ID
{"type": "string"}
datahub_ingestion_schema.json
hmac_access_secret
Secret
{"type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
platform_override_map
A holder for platform -> platform mappings to generate correct dataset urns
{"type": "object", "additionalProperties": {"type": "string"}}
datahub_ingestion_schema.json
database_override_map
A holder for database -> database mappings to generate correct dataset urns
{"type": "object", "additionalProperties": {"type": "string"}}
datahub_ingestion_schema.json
NifiAuthType
An enumeration.
{"enum": ["NO_AUTH", "SINGLE_USER", "CLIENT_CERT", "KERBEROS", "BASIC_AUTH"]}
datahub_ingestion_schema.json
FileReadMode
An enumeration.
{"enum": ["STREAM", "BATCH", "AUTO"]}
datahub_ingestion_schema.json
enabled
Whether profiling should be done.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
operation_config
Experimental feature. To specify operation configs.
{"allOf": [{}]}
datahub_ingestion_schema.json
profile_table_level_only
Whether to perform profiling at table-level only or include column-level profiling as well.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
max_number_of_fields_to_profile
A positive integer that specifies the maximum number of columns to profile for any table. `None` implies all columns. The cost of profiling goes up significantly as the number of columns to profile goes up.
{"exclusiveMinimum": 0, "type": "integer"}
datahub_ingestion_schema.json
include_field_null_count
Whether to profile for the number of nulls for each column.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_min_value
Whether to profile for the min value of numeric columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_max_value
Whether to profile for the max value of numeric columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_mean_value
Whether to profile for the mean value of numeric columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_median_value
Whether to profile for the median value of numeric columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_stddev_value
Whether to profile for the standard deviation of numeric columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_quantiles
Whether to profile for the quantiles of numeric columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_distinct_value_frequencies
Whether to profile for distinct value frequencies.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_histogram
Whether to profile for the histogram for numeric fields.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_field_sample_values
Whether to profile for the sample values for all columns.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
SalesforceAuthType
An enumeration.
{"enum": ["USERNAME_PASSWORD", "DIRECT_ACCESS_TOKEN", "JSON_WEB_TOKEN"]}
datahub_ingestion_schema.json
enabled
Whether profiling should be done. Supports only table-level profiling at this stage
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
operation_config
Experimental feature. To specify operation configs.
{"allOf": [{}]}
datahub_ingestion_schema.json
match
Pattern to match on uri-s as part of reference resolution. See replace field
{"type": "string"}
datahub_ingestion_schema.json
replace
Pattern to replace with as part of reference resolution. See match field
{"type": "string"}
datahub_ingestion_schema.json
row_count
The parameter name for row count in glue table.
{"type": "string"}
datahub_ingestion_schema.json
column_count
The parameter name for column count in glue table.
{"type": "string"}
datahub_ingestion_schema.json
unique_count
The parameter name for the count of unique value in a column.
{"type": "string"}
datahub_ingestion_schema.json
unique_proportion
The parameter name for the proportion of unique values in a column.
{"type": "string"}
datahub_ingestion_schema.json
null_count
The parameter name for the count of null values in a column.
{"type": "string"}
datahub_ingestion_schema.json
null_proportion
The parameter name for the proportion of null values in a column.
{"type": "string"}
datahub_ingestion_schema.json
min
The parameter name for the min value of a column.
{"type": "string"}
datahub_ingestion_schema.json
max
The parameter name for the max value of a column.
{"type": "string"}
datahub_ingestion_schema.json
mean
The parameter name for the mean value of a column.
{"type": "string"}
datahub_ingestion_schema.json
median
The parameter name for the median value of a column.
{"type": "string"}
datahub_ingestion_schema.json
stdev
The parameter name for the standard deviation of a column.
{"type": "string"}
datahub_ingestion_schema.json
partition_patterns
Regex patterns for filtering partitions for profile. The pattern should be a string like: "{'key':'value'}".
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
operation_config
Experimental feature. To specify operation configs.
{"allOf": [{}]}
datahub_ingestion_schema.json
items
Transformer configs see at https://datahubproject.io/docs/metadata-ingestion/docs/transformer
{"type": "object", "properties": {"type": {"type": "string"}, "config": {"type": "object"}}, "required": ["type"], "additionalProperties": false}
datahub_ingestion_schema.json
type
Transformer type
{"type": "string"}
datahub_ingestion_schema.json
config
Transformer config
{"type": "object"}
datahub_ingestion_schema.json
sink
sink
{"anyOf": [{}, {}, {}, {}]}
lsdlschema.json
Linguistic Schema Definition Language schema
{"$schema": "http://json-schema.org/draft-04/schema#", "anyOf": [{}, {}, {}, {}, {}, {}, {}, {}, {}], "id": "https://json.schemastore.org/lsdlschema.json"}
fossa-yml.v3.schema.json
.fossa.yaml specification for FOSSA CLI 2.x or greater
{"$schema": "http://json-schema.org/draft-07/schema#", "$defs": {"project": {"type": "object", "properties": {"id": {"type": "string", "minLength": 1}, "name": {"type": "string", "minLength": 1}, "team": {"type": "string", "minLength": 1}, "policy": {"type": "integer", "minLength": 1}, "link": {"type": "string", "minLength": 1}, "url": {"type": "string", "minLength": 1}, "jiraProjectKey": {"type": "string", "minLength": 1}, "releaseGroup": {"type": "object", "properties": {"name": {"type": "string", "minLength": 1}, "release": {"type": "string", "minLength": 1}}, "required": ["name", "release"]}, "labels": {"type": "array", "items": {"type": "string"}}}}, "telemetry": {"type": "object", "properties": {"scope": {"type": "string", "oneOf": [{"const": "full"}, {"const": "off"}]}, "commit": {"type": "string", "minLength": 1}}}, "revision": {"type": "object", "properties": {"branch": {"type": "string", "minLength": 1}, "commit": {"type": "string", "minLength": 1}}}, "targetFilter": {"type": "object", "properties": {"type": {"type": "string", "oneOf": [{"const": "bundler"}, {"const": "cargo"}, {"const": "carthage"}, {"const": "cocoapods"}, {"const": "composer"}, {"const": "conda"}, {"const": "glide"}, {"const": "godep"}, {"const": "gradle"}, {"const": "leiningen"}, {"const": "maven"}, {"const": "mix"}, {"const": "npm"}, {"const": "nimble"}, {"const": "pub"}, {"const": "rebar3"}, {"const": "rpm"}, {"const": "renv"}, {"const": "scala"}, {"const": "swift"}, {"const": "yarn"}, {"const": "repomanifest"}, {"const": "cabal"}, {"const": "stack"}, {"const": "nuspec"}, {"const": "packagereference"}, {"const": "paket"}, {"const": "projectassetjson"}, {"const": "pipenv"}, {"const": "poetry"}, {"const": "setuptools"}, {"const": "perl"}, {"const": "pnpm"}, {"const": "pdm"}]}, "path": {"type": "string"}}}, "experimental": {"type": "object", "properties": {"gradle": {"type": "object", "properties": {"configurations-only": {"type": "array", "items": {"type": "string"}, "minItems": 1, "uniqueItems": true}}}}}, "vendoredDependencies": {"type": "object", "properties": {"forceRescans": {"type": "boolean"}, "scanMethod": {"type": "string", "oneOf": [{"const": "ArchiveUpload"}, {"const": "CLILicenseScan"}]}, "licenseScanPathFilters": {"type": "object", "properties": {"only": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}}}}}}, "type": "object", "properties": {"version": {"type": "integer", "const": 3}, "server": {"type": "string", "minLength": 1}, "apiKey": {"type": "string", "minLength": 1}, "project": {}, "telemetry": {}, "vendoredDependencies": {}, "revision": {"type": "array", "items": {}}, "targets": {"type": "object", "properties": {"only": {"type": "array", "items": {}}, "exclude": {"type": "array", "items": {}}}}, "paths": {"type": "object", "properties": {"only": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}}}}, "required": ["version"]}
fossa-yml.v3.schema.json
project
The project fields allow you to configure settings for the project you are interacting with through the FOSSA API.
{"type": "object", "properties": {"id": {"type": "string", "minLength": 1}, "name": {"type": "string", "minLength": 1}, "team": {"type": "string", "minLength": 1}, "policy": {"type": "integer", "minLength": 1}, "link": {"type": "string", "minLength": 1}, "url": {"type": "string", "minLength": 1}, "jiraProjectKey": {"type": "string", "minLength": 1}, "releaseGroup": {"type": "object", "properties": {"name": {"type": "string", "minLength": 1}, "release": {"type": "string", "minLength": 1}}, "required": ["name", "release"]}, "labels": {"type": "array", "items": {"type": "string"}}}}
fossa-yml.v3.schema.json
id
The project ID defines a unique ID that the FOSSA API will use to reference this project. The project ID can be found in the UI on the project settings page listed as the `Project Locator` underneath the `Project Title` setting. By default, it will use git remote origin url as project id if it's git repository. If it does not recognize version control system (vcs), project directory's name will be used.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
name
The name field sets the projects visible name in the FOSSA dashboard. By default, this will be set to the project's ID.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
team
The name of the team in your FOSSA organization to associate this project with.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
policy
The id of the policy in your FOSSA organization to associate this project with. Mutually excludes `project.policy`.
{"type": "integer", "minLength": 1}
fossa-yml.v3.schema.json
link
An external link that will appear in the FOSSA UI for this specific project.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
url
The URL of your project that will appear in FOSSA. This URL is intended to be the URL to the repository of this project.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
jiraProjectKey
The Jira Project Key to associate with your project for improved issue triage. Refer to https://docs.fossa.com/docs/atlassian-jira#linking-fossa-projects-to-jira-projects for more information.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
releaseGroup
The `name:` and `release:` of the release group's release to add your project to in the FOSSA dashboard. If you choose to associate a project with a release group, you **must** supply both name and release.
{"type": "object", "properties": {"name": {"type": "string", "minLength": 1}, "release": {"type": "string", "minLength": 1}}, "required": ["name", "release"]}
fossa-yml.v3.schema.json
name
The name of release group.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
release
The release associated with the release group
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
labels
A list of labels that are assigned to the project
{"type": "array", "items": {"type": "string"}}
fossa-yml.v3.schema.json
telemetry
The telemetry fields are used to configure telemetry data collection and it's destination.
{"type": "object", "properties": {"scope": {"type": "string", "oneOf": [{"const": "full"}, {"const": "off"}]}, "commit": {"type": "string", "minLength": 1}}}
fossa-yml.v3.schema.json
scope
project branch is an optional setting used for organizing project revisions in the FOSSA UI. The branch field is intended to function similar to how Git defines a branch.
{"type": "string", "oneOf": [{"const": "full"}, {"const": "off"}]}
fossa-yml.v3.schema.json
scope
Collects and sends ends telemetry data to server.
{"const": "full"}
fossa-yml.v3.schema.json
scope
Does not send telemetry data to server.
{"const": "off"}
fossa-yml.v3.schema.json
commit
The commit is used to identify a specific scan for a project (determined by project.id). This is intended to be used identically to how Git treats commit hashes. If not provided, cli will parse current HEAD state from .git directory. If project does not have version control system, unix timestamp will be used.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
revision
The revision fields are used to help FOSSA differentiate between one upload for a project and another, just as GitHub uses commit hashes and branch names.
{"type": "object", "properties": {"branch": {"type": "string", "minLength": 1}, "commit": {"type": "string", "minLength": 1}}}
fossa-yml.v3.schema.json
branch
project branch is an optional setting used for organizing project revisions in the FOSSA UI. The branch field is intended to function similar to how Git defines a branch.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
commit
The commit is used to identify a specific scan for a project (determined by project.id). This is intended to be used identically to how Git treats commit hashes. If not provided, cli will parse current HEAD state from .git directory. If project does not have version control system, unix timestamp will be used.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
type
Target (package manager)
{"type": "string", "oneOf": [{"const": "bundler"}, {"const": "cargo"}, {"const": "carthage"}, {"const": "cocoapods"}, {"const": "composer"}, {"const": "conda"}, {"const": "glide"}, {"const": "godep"}, {"const": "gradle"}, {"const": "leiningen"}, {"const": "maven"}, {"const": "mix"}, {"const": "npm"}, {"const": "nimble"}, {"const": "pub"}, {"const": "rebar3"}, {"const": "rpm"}, {"const": "renv"}, {"const": "scala"}, {"const": "swift"}, {"const": "yarn"}, {"const": "repomanifest"}, {"const": "cabal"}, {"const": "stack"}, {"const": "nuspec"}, {"const": "packagereference"}, {"const": "paket"}, {"const": "projectassetjson"}, {"const": "pipenv"}, {"const": "poetry"}, {"const": "setuptools"}, {"const": "perl"}, {"const": "pnpm"}, {"const": "pdm"}]}
fossa-yml.v3.schema.json
type
For bundler targets (ruby)
{"const": "bundler"}
fossa-yml.v3.schema.json
type
For cargo targets (rust)
{"const": "cargo"}
fossa-yml.v3.schema.json
type
For carthage targets (ios, objective-c)
{"const": "carthage"}
fossa-yml.v3.schema.json
type
For cocoapod targets (ios, objective-c, swift)
{"const": "cocoapods"}
fossa-yml.v3.schema.json
type
For composer targets (php)
{"const": "composer"}
fossa-yml.v3.schema.json
type
For conda targets
{"const": "conda"}
fossa-yml.v3.schema.json
type
For glide targets (golang)
{"const": "glide"}
fossa-yml.v3.schema.json
type
For godep targets (golang)
{"const": "godep"}
fossa-yml.v3.schema.json
type
For gradle targets (kotlin and java)
{"const": "gradle"}
fossa-yml.v3.schema.json
type
For leiningen targets (clojure)
{"const": "leiningen"}
fossa-yml.v3.schema.json
type
For maven targets (kotlin and java)
{"const": "maven"}
fossa-yml.v3.schema.json
type
For mix targets (elixir)
{"const": "mix"}
fossa-yml.v3.schema.json
type
For npm targets (javascript)
{"const": "npm"}
fossa-yml.v3.schema.json
type
For nimble targets (nim)
{"const": "nimble"}
fossa-yml.v3.schema.json
type
For pub targets (dart, flutter)
{"const": "pub"}
fossa-yml.v3.schema.json
type
For rebar3 targets (erlang)
{"const": "rebar3"}
fossa-yml.v3.schema.json
type
For rpm targets
{"const": "rpm"}
fossa-yml.v3.schema.json
type
For renv targets (r)
{"const": "renv"}
fossa-yml.v3.schema.json
type
For scala targets
{"const": "scala"}
fossa-yml.v3.schema.json
type
For swift targets
{"const": "swift"}
fossa-yml.v3.schema.json
type
For yarn targets (javascript)
{"const": "yarn"}
fossa-yml.v3.schema.json
type
For repomanifest
{"const": "repomanifest"}
fossa-yml.v3.schema.json
type
For cabal targets (haskell)
{"const": "cabal"}
fossa-yml.v3.schema.json
type
For stack targets (haskell)
{"const": "stack"}
fossa-yml.v3.schema.json
type
For nuspec targets (dotnet)
{"const": "nuspec"}
fossa-yml.v3.schema.json
type
For package reference targets (dotnet)
{"const": "packagereference"}
fossa-yml.v3.schema.json
type
For paket targets (dotnet)
{"const": "paket"}
fossa-yml.v3.schema.json
type
For project asset json targets (dotnet)
{"const": "projectassetjson"}