json_schema
stringlengths 43
1.28M
| unique_id
stringlengths 2
41
|
|---|---|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"statusCode",
"reasonPhrase"
],
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"reasonPhrase": {
"type": "string"
},
"message": {
"type": "string"
},
"details": {},
"stackTrace": {
"$ref": "#/definitions/exception"
}
},
"definitions": {
"exception": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"message": {
"type": "string"
},
"at": {
"type": "array",
"items": {
"type": "string"
}
},
"suppressed": {
"type": "array",
"items": {
"$ref": "#/definitions/maybeCircularException"
}
},
"causedBy": {
"$ref": "#/definitions/maybeCircularException"
}
}
},
"circularReference": {
"type": "object",
"additionalProperties": false,
"required": [
"circularReference"
],
"properties": {
"circularReference": {
"$ref": "#/definitions/exception"
}
}
},
"maybeCircularException": {
"oneOf": [
{
"$ref": "#/definitions/exception"
},
{
"$ref": "#/definitions/circularReference"
}
]
}
}
} | o39146 |
{
"properties": {
"accounting": {
"enum": [
"ON",
"OFF"
],
"type": "string"
},
"authentication": {
"enum": [
"ON",
"OFF"
],
"type": "string"
},
"authservretry": {
"type": "integer"
},
"authtimeout": {
"type": "integer"
},
"builtin": {
"enum": [
"MODIFIABLE",
"DELETABLE",
"IMMUTABLE",
"PARTITION_ALL"
],
"readonly": true,
"type": "object"
},
"callingstationid": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"defaultauthenticationgroup": {
"type": "string"
},
"feature": {
"enum": [
"WL",
"WebLogging",
"SP",
"SurgeProtection",
"LB",
"LoadBalancing",
"CS",
"ContentSwitching",
"CR",
"CacheRedirection",
"SC",
"SureConnect",
"CMP",
"CMPcntl",
"CompressionControl",
"PQ",
"PriorityQueuing",
"HDOSP",
"HttpDoSProtection",
"SSLVPN",
"AAA",
"GSLB",
"GlobalServerLoadBalancing",
"SSL",
"SSLOffload",
"SSLOffloading",
"CF",
"ContentFiltering",
"IC",
"IntegratedCaching",
"OSPF",
"OSPFRouting",
"RIP",
"RIPRouting",
"BGP",
"BGPRouting",
"REWRITE",
"IPv6PT",
"IPv6protocoltranslation",
"AppFw",
"ApplicationFirewall",
"RESPONDER",
"HTMLInjection",
"push",
"NSPush",
"NetScalerPush",
"AppFlow",
"CloudBridge",
"ISIS",
"ISISRouting",
"CH",
"CallHome",
"AppQoE",
"ContentAccelerator",
"SYSTEM",
"RISE",
"FEO",
"LSN",
"LargeScaleNAT",
"RDPProxy",
"Rep",
"Reputation",
"URLFiltering",
"VideoOptimization",
"ForwardProxy",
"SSLInterception",
"AdaptiveTCP",
"CQA",
"CI",
"ContentInspection",
"Bot"
],
"readonly": true,
"type": "string"
},
"groupauthname": {
"readonly": true,
"type": "string"
},
"ipaddress": {
"readonly": true,
"type": "string"
},
"ipattributetype": {
"type": "integer"
},
"ipvendorid": {
"type": "integer"
},
"passencoding": {
"enum": [
"pap",
"chap",
"mschapv1",
"mschapv2"
],
"type": "string"
},
"pwdattributetype": {
"type": "integer"
},
"pwdvendorid": {
"type": "integer"
},
"radattributetype": {
"type": "integer"
},
"radgroupseparator": {
"type": "string"
},
"radgroupsprefix": {
"type": "string"
},
"radkey": {
"type": "string"
},
"radnasid": {
"type": "string"
},
"radnasip": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"radvendorid": {
"type": "integer"
},
"serverip": {
"type": "string"
},
"serverport": {
"type": "integer"
},
"tunnelendpointclientip": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
}
},
"title": "aaaradiusparams",
"type": "object"
} | o29941 |
{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "TSlint Target",
"description": "TSlint target options for Build Facade.",
"type": "object",
"properties": {
"tslintConfig": {
"type": "string",
"description": "The name of the TSLint configuration file."
},
"tsConfig": {
"description": "The name of the TypeScript configuration file.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"fix": {
"type": "boolean",
"description": "Fixes linting errors (may overwrite linted files).",
"default": false
},
"typeCheck": {
"type": "boolean",
"description": "Controls the type check for linting.",
"default": false
},
"force": {
"type": "boolean",
"description": "Succeeds even if there was linting errors.",
"default": false
},
"silent": {
"type": "boolean",
"description": "Show output text.",
"default": false
},
"format": {
"type": "string",
"description": "Output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist).",
"default": "stylish",
"anyOf": [
{
"enum": [
"checkstyle",
"codeFrame",
"filesList",
"json",
"junit",
"msbuild",
"pmd",
"prose",
"stylish",
"tap",
"verbose",
"vso"
]
},
{
"minLength": 1
}
]
},
"exclude": {
"type": "array",
"description": "Files to exclude from linting.",
"default": [],
"items": {
"type": "string"
}
},
"files": {
"type": "array",
"description": "Files to include in linting.",
"default": [],
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": []
} | o58449 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"absolute_path": {
"description": "A path only. Query string and/or fragment are not allowed.",
"pattern": "^/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?$",
"type": "string"
},
"analytics_identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations."
},
"change_history": {
"items": {
"additionalProperties": false,
"properties": {
"note": {
"description": "A summary of the change",
"type": "string"
},
"public_timestamp": {
"_format": "date-time",
"type": "string"
}
},
"required": [
"public_timestamp",
"note"
],
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"description_optional": {
"anyOf": [
{
"$ref": "#/definitions/description"
},
{
"type": "null"
}
]
},
"details": {
"additionalProperties": false,
"properties": {
"change_history": {
"$ref": "#/definitions/change_history"
},
"ordered_agencies_and_other_public_bodies": {
"$ref": "#/definitions/summary_organisations"
},
"ordered_devolved_administrations": {
"$ref": "#/definitions/summary_organisations"
},
"ordered_executive_offices": {
"$ref": "#/definitions/summary_organisations"
},
"ordered_high_profile_groups": {
"$ref": "#/definitions/summary_organisations"
},
"ordered_ministerial_departments": {
"$ref": "#/definitions/summary_organisations"
},
"ordered_non_ministerial_departments": {
"$ref": "#/definitions/summary_organisations"
},
"ordered_public_corporations": {
"$ref": "#/definitions/summary_organisations"
}
},
"type": "object"
},
"first_published_at": {
"_format": "date-time",
"description": "The date the content was first published. Automatically determined by the publishing-api, unless overridden by the publishing application.",
"type": "string"
},
"frontend_links": {
"items": {
"additionalProperties": true,
"properties": {
"analytics_identifier": {
"$ref": "#/definitions/analytics_identifier"
},
"api_path": {
"$ref": "#/definitions/absolute_path"
},
"api_url": {
"_format": "uri",
"description": "DEPRECATED: api_path should be used instead of api_url. This is due to values of api_url being tied to an environment which can cause problems when data is synced between environments. In time this field will be removed by the Publishing Platform team.",
"type": "string"
},
"base_path": {
"$ref": "#/definitions/absolute_path"
},
"content_id": {
"$ref": "#/definitions/guid"
},
"document_type": {
"type": "string"
},
"links": {
"patternProperties": {
"^[a-z_]+$": {
"$ref": "#/definitions/frontend_links"
}
},
"type": "object"
},
"locale": {
"$ref": "#/definitions/locale"
},
"public_updated_at": {
"oneOf": [
{
"$ref": "#/definitions/public_updated_at"
},
{
"type": "null"
}
]
},
"schema_name": {
"type": "string"
},
"title": {
"type": "string"
},
"web_url": {
"_format": "uri",
"description": "DEPRECATED: base_path should be used instead of web_url. This is due to values of web_url being tied to an environment which can cause problems when data is synced between environments. In time this field will be removed by the Publishing Platform team.",
"type": "string"
}
},
"required": [
"content_id",
"locale",
"title"
],
"type": "object"
},
"type": "array"
},
"frontend_links_with_base_path": {
"items": {
"additionalProperties": true,
"properties": {
"analytics_identifier": {
"$ref": "#/definitions/analytics_identifier"
},
"api_path": {
"$ref": "#/definitions/absolute_path"
},
"api_url": {
"_format": "uri",
"description": "DEPRECATED: api_path should be used instead of api_url. This is due to values of api_url being tied to an environment which can cause problems when data is synced between environments. In time this field will be removed by the Publishing Platform team.",
"type": "string"
},
"base_path": {
"$ref": "#/definitions/absolute_path"
},
"content_id": {
"$ref": "#/definitions/guid"
},
"document_type": {
"type": "string"
},
"links": {
"patternProperties": {
"^[a-z_]+$": {
"$ref": "#/definitions/frontend_links_with_base_path"
}
},
"type": "object"
},
"locale": {
"$ref": "#/definitions/locale"
},
"public_updated_at": {
"oneOf": [
{
"$ref": "#/definitions/public_updated_at"
},
{
"type": "null"
}
]
},
"schema_name": {
"type": "string"
},
"title": {
"type": "string"
},
"web_url": {
"_format": "uri",
"description": "DEPRECATED: base_path should be used instead of web_url. This is due to values of web_url being tied to an environment which can cause problems when data is synced between environments. In time this field will be removed by the Publishing Platform team.",
"type": "string"
}
},
"required": [
"base_path",
"content_id",
"locale",
"title"
],
"type": "object"
},
"type": "array"
},
"guid": {
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
"type": "string"
},
"image": {
"additionalProperties": false,
"properties": {
"alt_text": {
"type": "string"
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"credit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"high_resolution_url": {
"_format": "uri",
"description": "URL to a high resolution version of the image, for use by third parties such as Twitter, Facebook or Slack. Used by the machine readable metadata component. Don't use this on user-facing web pages, as it might be very large.",
"type": "string"
},
"url": {
"_format": "uri",
"description": "URL to the image. The image should be in a suitable resolution for display on the page.",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"list_of_sub_organisations": {
"description": "A list of all sub-organisations of a particular type for a parent organisation. Turn into proper links once details for organisations no longer need to be expanded.",
"items": {
"additionalProperties": false,
"properties": {
"href": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"title",
"href"
],
"type": "object"
},
"type": "array"
},
"locale": {
"enum": [
"ar",
"az",
"be",
"bg",
"bn",
"cs",
"cy",
"da",
"de",
"dr",
"el",
"en",
"es",
"es-419",
"et",
"fa",
"fi",
"fr",
"gd",
"he",
"hi",
"hr",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"ka",
"kk",
"ko",
"lt",
"lv",
"ms",
"mt",
"nl",
"no",
"pl",
"ps",
"pt",
"ro",
"ru",
"si",
"sk",
"sl",
"so",
"sq",
"sr",
"sv",
"sw",
"ta",
"th",
"tk",
"tr",
"uk",
"ur",
"uz",
"vi",
"zh",
"zh-hk",
"zh-tw"
],
"type": "string"
},
"public_updated_at": {
"_format": "date-time",
"description": "When the content was last significantly changed (a major update). Shown to users. Automatically determined by the publishing-api, unless overridden by the publishing application.",
"type": "string"
},
"publishing_app_name": {
"description": "The application that published this item.",
"enum": [
"calculators",
"calendars",
"collections-publisher",
"contacts",
"content-publisher",
"content-tagger",
"email-alert-frontend",
"external-link-tracker",
"feedback",
"frontend",
"government-frontend",
"hmrc-manuals-api",
"info-frontend",
"licencefinder",
"local-links-manager",
"manuals-frontend",
"manuals-publisher",
"maslow",
"performanceplatform-big-screen-view",
"publisher",
"rummager",
"search-admin",
"search-api",
"service-manual-publisher",
"share-sale-publisher",
"short-url-manager",
"smartanswers",
"special-route-publisher",
"specialist-publisher",
"static",
"tariff",
"travel-advice-publisher",
"whitehall"
],
"type": "string"
},
"publishing_request_id": {
"description": "A unique identifier used to track publishing requests to rendered content",
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publishing_scheduled_at": {
"_format": "date-time",
"description": "When this content was last scheduled for publishing. Determined by the publishing intent sent by the publishing API.",
"type": "string"
},
"rendering_app": {
"description": "The application that renders this item.",
"enum": [
"calculators",
"calendars",
"collections",
"content-store",
"email-alert-frontend",
"email-campaign-frontend",
"feedback",
"finder-frontend",
"frontend",
"government-frontend",
"info-frontend",
"licencefinder",
"manuals-frontend",
"performanceplatform-big-screen-view",
"rummager",
"search-api",
"service-manual-frontend",
"smartanswers",
"spotlight",
"static",
"tariff",
"whitehall-admin",
"whitehall-frontend"
],
"type": "string"
},
"scheduled_publishing_delay_seconds": {
"description": "The delay between the most recent scheduled and actual publishing times. Determined by the content store based on the publishing intent.",
"type": "integer"
},
"summary_organisations": {
"description": "A list of all organisations of a particular type. Turn into proper links once details for organisations no longer need to be expanded.",
"items": {
"additionalProperties": false,
"properties": {
"acronym": {
"type": [
"string",
"null"
]
},
"analytics_identifier": {
"$ref": "#/definitions/analytics_identifier"
},
"brand": {
"type": [
"string",
"null"
]
},
"brand_colour_class": {
"type": "string"
},
"child_organisations": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"closed_at": {
"type": [
"string",
"null"
]
},
"content_id": {
"$ref": "#/definitions/guid"
},
"format": {
"type": "string"
},
"govuk_closed_status": {
"type": [
"string",
"null"
]
},
"govuk_status": {
"type": [
"string",
"null"
]
},
"href": {
"type": "string"
},
"logo": {
"properties": {
"crest": {
"enum": [
"bis",
"dit",
"eo",
"hmrc",
"ho",
"mod",
"portcullis",
"single-identity",
"so",
"ukaea",
"wales",
null
],
"type": [
"string",
"null"
]
},
"formatted_title": {
"type": "string"
},
"image": {
"$ref": "#/definitions/image"
},
"type_class_name": {
"type": "string"
}
},
"type": "object"
},
"parent_organisations": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"separate_website": {
"type": "boolean"
},
"slug": {
"type": "string"
},
"superseded_organisations": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"superseding_organisations": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"title": {
"type": "string"
},
"updated_at": {
"_format": "date-time",
"type": "string"
},
"works_with": {
"additionalProperties": false,
"properties": {
"adhoc_advisory_group": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"advisory_ndpb": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"civil_service": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"devolved_administration": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"executive_agency": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"executive_ndpb": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"executive_office": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"independent_monitoring_body": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"ministerial_department": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"non_ministerial_department": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"other": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"public_corporation": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"sub_organisation": {
"$ref": "#/definitions/list_of_sub_organisations"
},
"tribunal": {
"$ref": "#/definitions/list_of_sub_organisations"
}
},
"type": "object"
}
},
"required": [
"title",
"href",
"separate_website",
"format",
"slug",
"content_id"
],
"type": "object"
},
"type": "array"
},
"title": {
"type": "string"
},
"withdrawn_notice": {
"additionalProperties": false,
"properties": {
"explanation": {
"type": "string"
},
"withdrawn_at": {
"format": "date-time"
}
},
"type": "object"
}
},
"properties": {
"analytics_identifier": {
"$ref": "#/definitions/analytics_identifier"
},
"base_path": {
"$ref": "#/definitions/absolute_path"
},
"content_id": {
"$ref": "#/definitions/guid"
},
"description": {
"$ref": "#/definitions/description_optional"
},
"details": {
"$ref": "#/definitions/details"
},
"document_type": {
"enum": [
"finder"
],
"type": "string"
},
"first_published_at": {
"anyOf": [
{
"$ref": "#/definitions/first_published_at"
},
{
"type": "null"
}
]
},
"links": {
"additionalProperties": false,
"properties": {
"available_translations": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"child_taxons": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"children": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"document_collections": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"facet_groups": {
"$ref": "#/definitions/frontend_links",
"description": "Prototype-stage metadata tagging tree roots for this content item. A content item my belong to many facet groups without having any specific facet_values links."
},
"facet_values": {
"$ref": "#/definitions/frontend_links",
"description": "Prototype-stage metadata tagging values for this content item, a content item can be linked to many facet values from varying facet groups."
},
"finder": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Powers links from content back to finders the content is surfaced on"
},
"lead_organisations": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "DEPRECATED: A subset of organisations that should be emphasised in relation to this content item. All organisations specified here should also be part of the organisations array."
},
"level_one_taxons": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"mainstream_browse_pages": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Powers the /browse section of the site. These are known as sections in some legacy apps."
},
"meets_user_needs": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "The user needs this piece of content meets."
},
"ministers": {
"$ref": "#/definitions/frontend_links",
"description": "Link type automatically added by Publishing API"
},
"ordered_related_items": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Related items, can be any page on GOV.UK. Mostly used for mainstream content to power the sidebar. Ordering of the links is determined by the editor in Content Tagger."
},
"ordered_related_items_overrides": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Related items, can be any page on GOV.UK. Overrides 'more like this' automatically generated links in the beta navigation."
},
"organisations": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "All organisations linked to this content item. This should include lead organisations."
},
"original_primary_publishing_organisation": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "The organisation that published the original version of the page. Corresponds to the first of the 'Lead organisations' in Whitehall for the first edition, and is empty for all other publishing applications."
},
"parent": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "The parent content item.",
"maxItems": 1
},
"part_of_step_navs": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"policies": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"policy_areas": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "A largely deprecated tag currently only used to power email alerts."
},
"primary_publishing_organisation": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "The organisation that published the page. Corresponds to the first of the 'Lead organisations' in Whitehall, and is empty for all other publishing applications.",
"maxItems": 1
},
"related_to_step_navs": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"role_appointments": {
"$ref": "#/definitions/frontend_links",
"description": "Link type automatically added by Publishing API"
},
"secondary_to_step_navs": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"suggested_ordered_related_items": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "New A/B test suggestions for related items. Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms included in this A/B test."
},
"taxons": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Prototype-stage taxonomy label for this content item"
},
"topic_taxonomy_taxons": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Link type automatically added by Publishing API"
},
"topics": {
"$ref": "#/definitions/frontend_links_with_base_path",
"description": "Powers the /topic section of the site. These are known as specialist sectors in some legacy apps."
}
},
"type": "object"
},
"locale": {
"$ref": "#/definitions/locale"
},
"need_ids": {
"items": {
"type": "string"
},
"type": "array"
},
"phase": {
"description": "The service design phase of this content item - https://www.gov.uk/service-manual/phases",
"enum": [
"alpha",
"beta",
"live"
],
"type": "string"
},
"public_updated_at": {
"anyOf": [
{
"$ref": "#/definitions/public_updated_at"
},
{
"type": "null"
}
]
},
"publishing_app": {
"$ref": "#/definitions/publishing_app_name"
},
"publishing_request_id": {
"$ref": "#/definitions/publishing_request_id"
},
"publishing_scheduled_at": {
"anyOf": [
{
"$ref": "#/definitions/publishing_scheduled_at"
},
{
"type": "null"
}
]
},
"rendering_app": {
"$ref": "#/definitions/rendering_app"
},
"scheduled_publishing_delay_seconds": {
"anyOf": [
{
"$ref": "#/definitions/scheduled_publishing_delay_seconds"
},
{
"type": "null"
}
]
},
"schema_name": {
"enum": [
"organisations_homepage"
],
"type": "string"
},
"title": {
"$ref": "#/definitions/title"
},
"updated_at": {
"_format": "date-time",
"type": "string"
},
"withdrawn_notice": {
"$ref": "#/definitions/withdrawn_notice"
}
},
"required": [
"base_path",
"content_id",
"description",
"details",
"document_type",
"links",
"locale",
"public_updated_at",
"schema_name",
"title",
"updated_at"
],
"type": "object"
} | o21311 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://qiskit.org/backend/configuration-01/schema#",
"description": "QISKit device backend configuration",
"type": "object",
"required": [
"name",
"coupling_map",
"basis_gates",
"simulator",
"local"
],
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"simulator": {
"type": "boolean",
"default": false
},
"local": {
"type": "boolean",
"default": false
},
"description": {
"type": "string"
},
"n_qubits": {
"type": "integer",
"minimum": 1
},
"coupling_map": {
"oneOf": [
{
"type": "string",
"enum": [
"all-to-all"
]
},
{
"type": "array",
"items": {
"type": "array",
"item": "integer",
"minItems": 2,
"maxItems": 2,
"_uniqueItems": true
},
"_uniqueItems": true
}
]
},
"basis_gates": {
"type": "string"
},
"online_date": {
"type": "string",
"format": "date"
},
"chip_name": {
"type": "string"
}
}
} | o24463 |
{
"properties": {
"customer_name": {
"description": "The name of the customer",
"type": "string"
},
"items": {
"description": "The items included in the invoice",
"items": {
"properties": {
"description": {
"description": "The description of the item",
"type": "string"
},
"quantity": {
"description": "The quantity of the item",
"type": "integer"
},
"unit_price": {
"description": "The unit price of the item",
"type": "number"
}
},
"required": [
"description",
"quantity",
"unit_price"
],
"type": "object"
},
"type": "array"
},
"tax_rate": {
"description": "The tax rate in percentage",
"type": "number"
}
},
"required": [
"customer_name",
"items",
"tax_rate"
],
"type": "object"
} | generate_invoice_c2c9a7d3 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Tabular Data Package",
"description": "Tabular Data Package is a format and specification for convenient delivery, installation and management of tabular data.",
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "A lower-case string with only alphanumeric characters along with '.', '_' or '-' characters.",
"pattern": "^([a-z0-9._-])+$",
"propertyOrder": 10
},
"title": {
"title": "Title",
"description": "A human-readable title for this package.",
"type": "string",
"propertyOrder": 20
},
"description": {
"title": "Description",
"description": "A text description of the package.",
"type": "string",
"propertyOrder": 30,
"format": "textarea"
},
"homepage": {
"title": "Home Page",
"description": "The URL for this data package's website.",
"type": "string",
"propertyOrder": 40
},
"version": {
"title": "Version",
"description": "A semantic versioning string for this package.",
"type": "string",
"propertyOrder": 50
},
"licences": {
"title": "Licenses",
"description": "The license(s) under which this package is published.",
"type": "array",
"propertyOrder": 60,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
}
},
"anyOf": [
{
"title": "id required",
"required": [
"id"
]
},
{
"title": "url required",
"required": [
"url"
]
}
]
}
},
"author": {
"title": "Author",
"description": "The main contributor to this package.",
"type": "string",
"propertyOrder": 70
},
"contributors": {
"title": "Contributors",
"description": "The contributors to this package.",
"type": "array",
"propertyOrder": 80,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"web": {
"type": "string"
}
},
"required": [
"name"
]
}
},
"resources": {
"title": "Resources",
"description": "The data resources that this package describes.",
"type": "array",
"propertyOrder": 90,
"minItems": 1,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "A lower-case string with only alphanumeric characters along with '.', '_' or '-' characters.",
"type": "string",
"pattern": "^([a-z0-9._-])+$",
"propertyOrder": 10
},
"title": {
"title": "Title",
"description": "A human-readable title for this package.",
"type": "string",
"propertyOrder": 20
},
"description": {
"title": "Description",
"description": "A text description of the package.",
"type": "string",
"propertyOrder": 30,
"format": "textarea"
},
"schema": {
"title": "Schema",
"description": "The schema of this resource.",
"type": "object",
"propertyOrder": 40
},
"url": {
"title": "URL",
"description": "The URL for this resource.",
"type": "string",
"propertyOrder": 50
},
"path": {
"title": "Path",
"description": "The relative path to this resource.",
"type": "string",
"propertyOrder": 60
},
"format": {
"title": "Format",
"description": "The file format of this resource.",
"type": "string",
"propertyOrder": 70
},
"mediatype": {
"title": "Media Type",
"description": "The media type of this resource.",
"type": "string",
"propertyOrder": 80,
"pattern": "^(.+)/(.+)$"
},
"encoding": {
"title": "Encoding",
"description": "The file encoding of this resource.",
"type": "string",
"propertyOrder": 90
},
"bytes": {
"title": "Bytes",
"description": "The size of this resource in bytes.",
"type": "integer",
"propertyOrder": 100
},
"hash": {
"title": "Hash",
"type": "string",
"description": "The MD5 hash of this resource. Other hash algorithms can be used by prefixing the hash value with the algorithm name in lowercase, followed by a colon.",
"propertyOrder": 110,
"pattern": "^([^:]+:[a-fA-F0-9]+|[a-fA-F0-9]{32})$"
},
"dialect": {
"title": "Dialect",
"description": "The dialect of this resource file type.",
"type": "object",
"propertyOrder": 120
},
"sources": {
"title": "Sources",
"description": "The raw sources for this resource.",
"type": "array",
"propertyOrder": 130,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"web": {
"type": "string"
},
"email": {
"type": "string"
}
},
"anyOf": [
{
"title": "name required",
"required": [
"name"
]
},
{
"title": "web required",
"required": [
"web"
]
},
{
"title": "email required",
"required": [
"email"
]
}
]
}
},
"licences": {
"title": "Licenses",
"description": "The license(s) under which this resource is released.",
"type": "array",
"propertyOrder": 140,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
}
},
"anyOf": [
{
"title": "id required",
"required": [
"id"
]
},
{
"title": "url required",
"required": [
"url"
]
}
]
}
}
},
"anyOf": [
{
"title": "url required",
"required": [
"name",
"schema",
"url"
]
},
{
"title": "path required",
"required": [
"name",
"schema",
"path"
]
}
]
}
},
"keywords": {
"title": "Keywords",
"description": "A list of keywords that describe this package.",
"type": "array",
"propertyOrder": 100,
"items": {
"type": "string"
}
},
"sources": {
"title": "Sources",
"description": "The raw sources for this package.",
"type": "array",
"propertyOrder": 110,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"web": {
"type": "string"
},
"email": {
"type": "string"
}
},
"anyOf": [
{
"title": "name required",
"required": [
"name"
]
},
{
"title": "web required",
"required": [
"web"
]
},
{
"title": "email required",
"required": [
"email"
]
}
]
}
},
"image": {
"title": "Image",
"description": "A image to represent this package.",
"type": "string",
"propertyOrder": 120
},
"base": {
"title": "Base",
"description": "A base URI used to resolve resources that specify relative paths.",
"type": "string",
"propertyOrder": 130
},
"dataDependencies": {
"title": "Data Dependencies",
"description": "Pre-requisite Data Packages on which this package requires in order to install.",
"type": "object",
"propertyOrder": 140
}
},
"required": [
"name",
"resources"
]
} | o84208 |
{
"additionalProperties": false,
"description": "Schema for a bad row resulting from enrichment failures",
"properties": {
"failure": {
"description": "Information regarding the enrichment failures",
"properties": {
"messages": {
"description": "List of failure messages associated with the enrichment failures",
"items": {
"additionalProperties": false,
"description": "Individual enrichment failure or null in case of validation",
"properties": {
"enrichment": {
"additionalProperties": false,
"description": "Information needed to identify an enrichment",
"properties": {
"identifier": {
"description": "Uniquely identifies the instance of of the enrichment which produced this failure",
"maxLength": 256,
"type": "string"
},
"schemaKey": {
"description": "The schema coordinates for this enrichment",
"type": "string"
}
},
"required": [
"schemaKey",
"identifier"
],
"type": [
"object",
"null"
]
},
"message": {
"anyOf": [
{
"additionalProperties": false,
"description": "Error which was internal to the enrichment regarding its input data",
"properties": {
"expectation": {
"description": "Expectation which was not met",
"maxLength": 256,
"type": "string"
},
"field": {
"description": "Field which did not meet the enrichment's expectations",
"maxLength": 64,
"type": "string"
},
"value": {
"description": "Stringified representation of the value which did not meet expectations",
"type": [
"string",
"null"
]
}
},
"required": [
"field",
"expectation"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Error which was external to the enrichment, e.g. a connection issue",
"properties": {
"error": {
"description": "Error that occurred",
"maxLength": 512,
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Supplied JSON did not validate against its schema (or schema was not found)",
"properties": {
"error": {
"anyOf": [
{
"additionalProperties": false,
"description": "Resolution error - schema could not be found in the specified repositories, defined by ResolutionError in the Iglu Client",
"properties": {
"error": {
"enum": [
"ResolutionError"
]
},
"lookupHistory": {
"items": {
"properties": {
"attempts": {
"description": "Number of attempts which have been made",
"minimum": 0,
"type": "integer"
},
"errors": {
"description": "Set of errors which happened for this repository",
"items": {
"properties": {
"error": {
"description": "Type of error (NotFound does not contain a message)",
"enum": [
"RepoFailure",
"ClientFailure",
"NotFound"
]
},
"message": {
"description": "Optional message in case of ClientFailure or RepoFailure",
"maxLength": 256,
"type": "string"
}
},
"required": [
"error"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"lastAttempt": {
"_format": "date-time",
"description": "Timestamp of a last attempt being made",
"type": "string"
},
"repostitory": {
"description": "Name of the repostitory as written in resolver.json",
"type": "string"
}
},
"required": [
"repository",
"errors",
"attempts",
"lastAttempt"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"error",
"lookupHistory"
]
},
{
"additionalProperties": false,
"description": "Data is invalid against resolved schema",
"properties": {
"dataReports": {
"items": {
"additionalProperties": false,
"properties": {
"keyword": {
"description": "JSON Schema Keywrod caused invalidation",
"type": [
"string",
"null"
]
},
"message": {
"description": "Human-readable message describing the issue with the schema",
"type": "string"
},
"path": {
"description": "JSON Path to an issue in the faulty JSON datum",
"type": [
"string",
"null"
]
},
"targets": {
"type": [
"array",
"null"
]
}
},
"required": [
"path",
"message",
"keyword",
"targets"
]
},
"minItems": 1,
"type": "array"
},
"error": {
"enum": [
"ValidationError"
]
}
},
"required": [
"dataReports"
]
},
{
"additionalProperties": false,
"description": "Schema is invalid and cannot be used to validate an instance",
"properties": {
"error": {
"enum": [
"ValidationError"
]
},
"schemaIssues": {
"description": "List of problems in resolved JSON schema",
"items": {
"additionalProperties": false,
"properties": {
"message": {
"description": "Human-readable message describing the issue with the schema",
"type": "string"
},
"path": {
"description": "JSON Path to an issue in the faulty JSON Schema",
"type": "string"
}
},
"required": [
"path",
"message"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"error"
]
}
],
"description": "Iglu client error"
},
"schemaKey": {
"description": "The iglu schema coordinates to validate against",
"type": "string"
}
},
"type": "object"
}
],
"description": "Information about the failure that happened for this enrichment",
"type": "object"
}
},
"required": [
"enrichment",
"message"
],
"type": "object"
},
"type": "array"
},
"timestamp": {
"_format": "date-time",
"description": "Timestamp at which the failure occurred",
"type": "string"
}
},
"type": "object"
},
"payload": {
"properties": {
"enriched": {
"additionalProperties": false,
"description": "The partially enriched event that resulted in schema violations",
"properties": {
"app_id": {
"type": [
"string",
"null"
]
},
"base_currency": {
"type": [
"string",
"null"
]
},
"br_colordepth": {
"type": [
"string",
"null"
]
},
"br_cookies": {
"type": [
"integer",
"null"
]
},
"br_family": {
"type": [
"string",
"null"
]
},
"br_features_director": {
"type": [
"integer",
"null"
]
},
"br_features_flash": {
"type": [
"integer",
"null"
]
},
"br_features_gears": {
"type": [
"integer",
"null"
]
},
"br_features_java": {
"type": [
"integer",
"null"
]
},
"br_features_pdf": {
"type": [
"integer",
"null"
]
},
"br_features_quicktime": {
"type": [
"integer",
"null"
]
},
"br_features_realplayer": {
"type": [
"integer",
"null"
]
},
"br_features_silverlight": {
"type": [
"integer",
"null"
]
},
"br_features_windowsmedia": {
"type": [
"integer",
"null"
]
},
"br_lang": {
"type": [
"string",
"null"
]
},
"br_name": {
"type": [
"string",
"null"
]
},
"br_renderengine": {
"type": [
"string",
"null"
]
},
"br_type": {
"type": [
"string",
"null"
]
},
"br_version": {
"type": [
"string",
"null"
]
},
"br_viewheight": {
"type": [
"integer",
"null"
]
},
"br_viewwidth": {
"type": [
"integer",
"null"
]
},
"collector_tstamp": {
"type": [
"string",
"null"
]
},
"contexts": {
"type": [
"string",
"null"
]
},
"derived_contexts": {
"type": [
"string",
"null"
]
},
"derived_tstamp": {
"type": [
"string",
"null"
]
},
"doc_charset": {
"type": [
"string",
"null"
]
},
"doc_height": {
"type": [
"integer",
"null"
]
},
"doc_width": {
"type": [
"integer",
"null"
]
},
"domain_sessionid": {
"type": [
"string",
"null"
]
},
"domain_sessionidx": {
"type": [
"integer",
"null"
]
},
"domain_userid": {
"type": [
"string",
"null"
]
},
"dvce_created_tstamp": {
"type": [
"string",
"null"
]
},
"dvce_ismobile": {
"type": [
"integer",
"null"
]
},
"dvce_screenheight": {
"type": [
"integer",
"null"
]
},
"dvce_screenwidth": {
"type": [
"integer",
"null"
]
},
"dvce_sent_tstamp": {
"type": [
"string",
"null"
]
},
"dvce_type": {
"type": [
"string",
"null"
]
},
"etl_tags": {
"type": [
"string",
"null"
]
},
"etl_tstamp": {
"type": [
"string",
"null"
]
},
"event": {
"type": [
"string",
"null"
]
},
"event_fingerprint": {
"type": [
"string",
"null"
]
},
"event_format": {
"type": [
"string",
"null"
]
},
"event_id": {
"type": [
"string",
"null"
]
},
"event_name": {
"type": [
"string",
"null"
]
},
"event_vendor": {
"type": [
"string",
"null"
]
},
"event_version": {
"type": [
"string",
"null"
]
},
"geo_city": {
"type": [
"string",
"null"
]
},
"geo_country": {
"type": [
"string",
"null"
]
},
"geo_latitude": {
"type": [
"number",
"null"
]
},
"geo_longitude": {
"type": [
"number",
"null"
]
},
"geo_region": {
"type": [
"string",
"null"
]
},
"geo_region_name": {
"type": [
"string",
"null"
]
},
"geo_timezone": {
"type": [
"string",
"null"
]
},
"geo_zipcode": {
"type": [
"string",
"null"
]
},
"ip_domain": {
"type": [
"string",
"null"
]
},
"ip_isp": {
"type": [
"string",
"null"
]
},
"ip_netspeed": {
"type": [
"string",
"null"
]
},
"ip_organization": {
"type": [
"string",
"null"
]
},
"mkt_campaign": {
"type": [
"string",
"null"
]
},
"mkt_clickid": {
"type": [
"string",
"null"
]
},
"mkt_content": {
"type": [
"string",
"null"
]
},
"mkt_medium": {
"type": [
"string",
"null"
]
},
"mkt_network": {
"type": [
"string",
"null"
]
},
"mkt_source": {
"type": [
"string",
"null"
]
},
"mkt_term": {
"type": [
"string",
"null"
]
},
"name_tracker": {
"type": [
"string",
"null"
]
},
"network_userid": {
"type": [
"string",
"null"
]
},
"os_family": {
"type": [
"string",
"null"
]
},
"os_manufacturer": {
"type": [
"string",
"null"
]
},
"os_name": {
"type": [
"string",
"null"
]
},
"os_timezone": {
"type": [
"string",
"null"
]
},
"page_referrer": {
"type": [
"string",
"null"
]
},
"page_title": {
"type": [
"string",
"null"
]
},
"page_url": {
"type": [
"string",
"null"
]
},
"page_urlfragment": {
"type": [
"string",
"null"
]
},
"page_urlhost": {
"type": [
"string",
"null"
]
},
"page_urlpath": {
"type": [
"string",
"null"
]
},
"page_urlport": {
"type": [
"integer",
"null"
]
},
"page_urlquery": {
"type": [
"string",
"null"
]
},
"page_urlscheme": {
"type": [
"string",
"null"
]
},
"platform": {
"type": [
"string",
"null"
]
},
"pp_xoffset_max": {
"type": [
"integer",
"null"
]
},
"pp_xoffset_min": {
"type": [
"integer",
"null"
]
},
"pp_yoffset_max": {
"type": [
"integer",
"null"
]
},
"pp_yoffset_min": {
"type": [
"integer",
"null"
]
},
"refr_domain_userid": {
"type": [
"string",
"null"
]
},
"refr_dvce_tstamp": {
"type": [
"string",
"null"
]
},
"refr_medium": {
"type": [
"string",
"null"
]
},
"refr_source": {
"type": [
"string",
"null"
]
},
"refr_term": {
"type": [
"string",
"null"
]
},
"refr_urlfragment": {
"type": [
"string",
"null"
]
},
"refr_urlhost": {
"type": [
"string",
"null"
]
},
"refr_urlpath": {
"type": [
"string",
"null"
]
},
"refr_urlport": {
"type": [
"integer",
"null"
]
},
"refr_urlquery": {
"type": [
"string",
"null"
]
},
"refr_urlscheme": {
"type": [
"string",
"null"
]
},
"se_action": {
"type": [
"string",
"null"
]
},
"se_category": {
"type": [
"string",
"null"
]
},
"se_label": {
"type": [
"string",
"null"
]
},
"se_property": {
"type": [
"string",
"null"
]
},
"se_value": {
"type": [
"string",
"null"
]
},
"ti_category": {
"type": [
"string",
"null"
]
},
"ti_currency": {
"type": [
"string",
"null"
]
},
"ti_name": {
"type": [
"string",
"null"
]
},
"ti_orderid": {
"type": [
"string",
"null"
]
},
"ti_price": {
"type": [
"string",
"null"
]
},
"ti_price_base": {
"type": [
"string",
"null"
]
},
"ti_quantity": {
"type": [
"integer",
"null"
]
},
"ti_sku": {
"type": [
"string",
"null"
]
},
"tr_affiliation": {
"type": [
"string",
"null"
]
},
"tr_city": {
"type": [
"string",
"null"
]
},
"tr_country": {
"type": [
"string",
"null"
]
},
"tr_currency": {
"type": [
"string",
"null"
]
},
"tr_orderid": {
"type": [
"string",
"null"
]
},
"tr_shipping": {
"type": [
"string",
"null"
]
},
"tr_shipping_base": {
"type": [
"string",
"null"
]
},
"tr_state": {
"type": [
"string",
"null"
]
},
"tr_tax": {
"type": [
"string",
"null"
]
},
"tr_tax_base": {
"type": [
"string",
"null"
]
},
"tr_total": {
"type": [
"string",
"null"
]
},
"tr_total_base": {
"type": [
"string",
"null"
]
},
"true_tstamp": {
"type": [
"string",
"null"
]
},
"txn_id": {
"type": [
"string",
"null"
]
},
"unstruct_event": {
"type": [
"string",
"null"
]
},
"user_fingerprint": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": [
"string",
"null"
]
},
"user_ipaddress": {
"type": [
"string",
"null"
]
},
"useragent": {
"type": [
"string",
"null"
]
},
"v_collector": {
"type": "string"
},
"v_etl": {
"type": "string"
},
"v_tracker": {
"type": [
"string",
"null"
]
}
}
},
"raw": {
"additionalProperties": false,
"description": "The raw event extracted from collector payload",
"properties": {
"contentType": {
"description": "Content type of the payload as detected by the collector",
"maxLength": 256,
"type": [
"string",
"null"
]
},
"encoding": {
"description": "Encoding of the collector payload",
"maxLength": 32,
"type": "string"
},
"headers": {
"description": "List of the headers part of this collector payload",
"items": {
"maxLength": 8192,
"type": "string"
},
"type": [
"array",
"null"
]
},
"hostname": {
"description": "Hostname of the payload as detected by the collector",
"maxLength": 8192,
"type": [
"string",
"null"
]
},
"ipAddress": {
"description": "IP address of the payload as detected by the collector",
"maxLength": 128,
"type": [
"string",
"null"
]
},
"loaderName": {
"maxLength": 32,
"type": "string"
},
"parameters": {
"description": "Tracker protocol parameters",
"type": "object"
},
"refererUri": {
"description": "Referer of the payload as detected by the collector",
"maxLength": 8192,
"type": [
"string",
"null"
]
},
"timestamp": {
"_format": "date-time",
"description": "Timestamp at which the payload was collected",
"type": [
"string",
"null"
]
},
"userId": {
"_format": "uuid",
"description": "Network user id associated with this payload",
"type": [
"string",
"null"
]
},
"useragent": {
"description": "User agent of the payload as detected by the collector",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"vendor": {
"description": "Vendor of the adapter that processed this payload, here com.snowplowanalytics.snowplow",
"maxLength": 64,
"type": "string"
},
"version": {
"description": "Version of the adapter that processed this payload",
"maxLength": 16,
"type": "string"
}
},
"required": [
"vendor",
"version",
"loaderName",
"encoding"
],
"type": "object"
}
},
"type": "object"
},
"processor": {
"additionalProperties": false,
"description": "Information about the piece of software responsible for the creation of enrichment failures",
"properties": {
"artifact": {
"description": "Artifact responsible for the creation of enrichment failures",
"maxLength": 512,
"type": "string"
},
"version": {
"description": "Version of the artifact responsible for the creation of enrichment failures",
"maxLength": 32,
"pattern": "^(\\d+\\.\\d+\\.\\d+.*)$",
"type": "string"
}
},
"required": [
"artifact",
"version"
],
"type": "object"
}
},
"required": [
"failure",
"payload",
"processor"
],
"self": {
"format": "jsonschema",
"name": "enrichment_failures",
"vendor": "com.snowplowanalytics.snowplow.badrows",
"version": "1-0-0"
},
"type": "object"
} | sp_330_Normalized |
{
"properties": {
"builtin": {
"enum": [
"MODIFIABLE",
"DELETABLE",
"IMMUTABLE",
"PARTITION_ALL"
],
"readonly": true,
"type": "object"
},
"bypasssafetycheck": {
"enum": [
"YES",
"NO"
],
"type": "string"
},
"comment": {
"type": "string"
},
"description": {
"readonly": true,
"type": "string"
},
"feature": {
"enum": [
"WL",
"WebLogging",
"SP",
"SurgeProtection",
"LB",
"LoadBalancing",
"CS",
"ContentSwitching",
"CR",
"CacheRedirection",
"SC",
"SureConnect",
"CMP",
"CMPcntl",
"CompressionControl",
"PQ",
"PriorityQueuing",
"HDOSP",
"HttpDoSProtection",
"SSLVPN",
"AAA",
"GSLB",
"GlobalServerLoadBalancing",
"SSL",
"SSLOffload",
"SSLOffloading",
"CF",
"ContentFiltering",
"IC",
"IntegratedCaching",
"OSPF",
"OSPFRouting",
"RIP",
"RIPRouting",
"BGP",
"BGPRouting",
"REWRITE",
"IPv6PT",
"IPv6protocoltranslation",
"AppFw",
"ApplicationFirewall",
"RESPONDER",
"HTMLInjection",
"push",
"NSPush",
"NetScalerPush",
"AppFlow",
"CloudBridge",
"ISIS",
"ISISRouting",
"CH",
"CallHome",
"AppQoE",
"ContentAccelerator",
"SYSTEM",
"RISE",
"FEO",
"LSN",
"LargeScaleNAT",
"RDPProxy",
"Rep",
"Reputation",
"URLFiltering",
"VideoOptimization",
"ForwardProxy",
"SSLInterception",
"AdaptiveTCP",
"CQA",
"CI",
"ContentInspection",
"Bot"
],
"readonly": true,
"type": "string"
},
"hits": {
"readonly": true,
"type": "integer"
},
"isdefault": {
"readonly": true,
"type": "boolean"
},
"name": {
"type": "string"
},
"newname": {
"type": "string"
},
"pattern": {
"type": "string"
},
"referencecount": {
"readonly": true,
"type": "integer"
},
"refinesearch": {
"type": "string"
},
"search": {
"type": "string"
},
"stringbuilderexpr": {
"type": "string"
},
"target": {
"type": "string"
},
"type": {
"enum": [
"noop",
"delete",
"insert_http_header",
"delete_http_header",
"corrupt_http_header",
"insert_before",
"insert_after",
"replace",
"replace_http_res",
"delete_all",
"replace_all",
"insert_before_all",
"insert_after_all",
"clientless_vpn_encode",
"clientless_vpn_encode_all",
"clientless_vpn_decode",
"clientless_vpn_decode_all",
"insert_sip_header",
"delete_sip_header",
"corrupt_sip_header",
"replace_sip_res",
"replace_diameter_header_field",
"replace_dns_header_field",
"replace_dns_answer_section"
],
"type": "string"
},
"undefhits": {
"readonly": true,
"type": "integer"
}
},
"title": "rewriteaction",
"type": "object"
} | o30867 |
{
"$id": "https://json.schemastore.org/drupal-config.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {
"title": "Configuration item",
"$ref": "#/definitions/configItem"
},
"definitions": {
"configItem": {
"type": "object",
"properties": {
"type": {
"title": "The type of the value",
"type": "string",
"examples": [
"boolean",
"integer",
"float",
"string",
"uri",
"email",
"mapping",
"sequence",
"label",
"text",
"config_object",
"config_entity"
]
},
"label": {
"title": "User interface label for the value",
"type": "string"
},
"translatable": {
"title": "Whether the defined type is translatable",
"type": "boolean"
},
"translation context": {
"title": "The translation context the source string belongs to",
"type": "string"
},
"nullable": {
"title": "Whether the value can be empty",
"type": "boolean"
},
"class": {
"title": "The class implementing parsing",
"type": "string"
},
"definition_class": {
"title": "The definition class",
"type": "string"
},
"orderby": {
"title": "Determines how the sequence should be sorted",
"type": "string"
},
"constraints": {
"title": "Validation constrains",
"type": "object"
},
"sequence": {
"$ref": "#/definitions/configItem"
},
"mapping": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configItem"
}
}
},
"additionalProperties": false
}
},
"title": "JSON schema for Drupal configuration schema file",
"type": "object"
}
| drupal-config |
{
"properties": {
"date_range": {
"properties": {
"end_date": {
"description": "The end date of the news articles",
"type": "string"
},
"start_date": {
"description": "The start date of the news articles",
"type": "string"
}
},
"type": "object"
},
"keywords": {
"description": "The keywords to search for",
"items": {
"type": "string"
},
"type": "array"
},
"language": {
"description": "The language of the news articles",
"type": "string"
}
},
"required": [
"keywords"
],
"type": "object"
} | search_news_9794a1ea |
{
"properties": {
"alertonly": {
"enum": [
"ON",
"OFF"
],
"type": "string"
},
"comment": {
"type": "string"
},
"cookieconsistency": {
"type": "string"
},
"isautodeployed": {
"enum": [
"AUTODEPLOYED",
"NOTAUTODEPLOYED"
],
"type": "string"
},
"isregex": {
"enum": [
"REGEX",
"NOTREGEX"
],
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
}
},
"title": "appfwprofile_cookieconsistency_binding",
"type": "object"
} | o30004 |
{
"$schema": "http://json-schema.org/draft-07/schema#",
"id": "https://json.schemastore.org/datahub-ingestion",
"title": "Datahub Ingestion",
"description": "Root schema of Datahub Ingestion",
"definitions": {
"console_sink": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"console"
]
}
},
"required": [
"type"
]
},
"file_sink": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"file"
]
},
"config": {
"$ref": "#/definitions/file_sink_config"
}
},
"required": [
"type",
"config"
]
},
"file_sink_config": {
"type": "object",
"properties": {
"filename": {
"description": "Path to file to write to.",
"type": "string"
}
},
"required": [
"filename"
],
"additionalProperties": false
},
"datahub_rest_sink": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"datahub-rest"
]
},
"config": {
"$ref": "#/definitions/datahub_rest_sink_config"
}
},
"required": [
"type",
"config"
],
"additionalProperties": false
},
"datahub_rest_sink_config": {
"type": "object",
"properties": {
"ca_certificate_path": {
"type": "string",
"description": "Path to server's CA certificate for verification of HTTPS communications"
},
"client_certificate_path": {
"type": "string",
"descritption": "Path to client's CA certificate for HTTPS communications"
},
"max_threads": {
"type": "number",
"description": "Experimental: Max parallelism for REST API calls",
"default": 15
},
"retry_status_codes": {
"type": "array",
"items": {
"type": "number"
},
"description": "Retry HTTP request also on these status codes",
"default": [
429,
502,
503,
504
]
},
"server": {
"type": "string",
"description": "URL of DataHub GMS endpoint."
},
"timeout_sec": {
"type": "number",
"description": "Per-HTTP request timeout.",
"default": 30
},
"token": {
"type": "string",
"description": "Bearer token used for authentication."
},
"extra_headers": {
"type": "string",
"description": "Extra headers which will be added to the request."
},
"disable_ssl_verification": {
"type": "boolean",
"description": "Disable SSL verification for HTTPS communications.",
"default": false
}
},
"required": [
"server"
],
"additionalProperties": false
},
"datahub_kafka_sink": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"datahub-kafka"
]
},
"config": {
"$ref": "#/definitions/datahub_kafka_sink_config"
}
},
"required": [
"type",
"config"
],
"additionalProperties": false
},
"datahub_kafka_sink_config": {
"type": "object",
"properties": {
"connection": {
"type": "object",
"properties": {
"bootstrap": {
"type": "string",
"description": "Kafka bootstrap URL.",
"default": "localhost:9092"
},
"producer_config": {
"type": "object",
"description": "Passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.SerializingProducer"
},
"schema_registry_url": {
"type": "string",
"description": "URL of schema registry being used.",
"default": "http://localhost:8081"
},
"schema_registry_config": {
"type": "object",
"description": "Passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.schema_registry.SchemaRegistryClient"
}
},
"additionalProperties": false,
"required": [
"bootstrap",
"schema_registry_url"
]
},
"topic_routes": {
"type": "object",
"properties": {
"MetadataChangeEvent": {
"type": "string",
"description": "Overridden Kafka topic name for the MetadataChangeEvent",
"default": "MetadataChangeEvent"
},
"MetadataChangeProposal": {
"type": "string",
"description": "Overridden Kafka topic name for the MetadataChangeProposal",
"default": "MetadataChangeProposal"
}
},
"additionalProperties": false
}
},
"required": [
"connection"
],
"additionalProperties": false
},
"mysql": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"mysql"
]
},
"config": {
"$ref": "#/definitions/mysql_config"
}
},
"required": [
"type",
"config"
]
},
"mysql_config": {
"title": "MySQLConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Deprecated in favour of database_pattern.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "MySQL host URL.",
"default": "localhost:3306",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"default": "mysql+pymysql",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "Regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
}
},
"additionalProperties": false
},
"oracle": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"oracle"
]
},
"config": {
"$ref": "#/definitions/oracle_config"
}
},
"required": [
"type",
"config"
]
},
"oracle_config": {
"title": "OracleConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "If using, omit `service_name`.",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "Will be set automatically to default value.",
"default": "oracle+cx_oracle",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"service_name": {
"title": "Service Name",
"description": "Oracle service name. If using, omit `database`.",
"type": "string"
},
"add_database_name_to_urn": {
"title": "Add Database Name To Urn",
"description": "Add oracle database name to urn, default urn is schema.table",
"default": false,
"type": "boolean"
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"powerbi-report-server": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"powerbi-report-server"
]
},
"config": {
"$ref": "#/definitions/powerbi-report-server_config"
}
},
"required": [
"type",
"config"
]
},
"powerbi-report-server_config": {
"title": "PowerBiReportServerDashboardSourceConfig",
"description": "Any source that produces dataset urns in a single environment should inherit this class",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"username": {
"title": "Username",
"description": "Windows account username",
"type": "string"
},
"password": {
"title": "Password",
"description": "Windows account password",
"type": "string"
},
"workstation_name": {
"title": "Workstation Name",
"description": "Workstation name",
"default": "localhost",
"type": "string"
},
"host_port": {
"title": "Host Port",
"description": "Power BI Report Server host URL",
"type": "string"
},
"server_alias": {
"title": "Server Alias",
"description": "Alias for Power BI Report Server host URL",
"default": "",
"type": "string"
},
"graphql_url": {
"title": "Graphql Url",
"description": "[deprecated] Not used",
"type": "string"
},
"report_virtual_directory_name": {
"title": "Report Virtual Directory Name",
"description": "Report Virtual Directory URL name",
"type": "string"
},
"report_server_virtual_directory_name": {
"title": "Report Server Virtual Directory Name",
"description": "Report Server Virtual Directory URL name",
"type": "string"
},
"extract_ownership": {
"title": "Extract Ownership",
"description": "Whether ownership should be ingested",
"default": true,
"type": "boolean"
},
"ownership_type": {
"title": "Ownership Type",
"description": "Ownership type of owner",
"default": "NONE",
"type": "string"
},
"platform_name": {
"title": "Platform Name",
"default": "powerbi",
"type": "string"
},
"platform_urn": {
"title": "Platform Urn",
"default": "urn:li:dataPlatform:powerbi",
"type": "string"
},
"report_pattern": {
"title": "Report Pattern",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"chart_pattern": {
"title": "Chart Pattern",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
}
},
"required": [
"username",
"password",
"host_port",
"report_virtual_directory_name",
"report_server_virtual_directory_name"
],
"additionalProperties": false
},
"datahub": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"datahub"
]
},
"config": {
"$ref": "#/definitions/datahub_config"
}
},
"required": [
"type",
"config"
]
},
"datahub_config": {
"title": "DataHubSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "Stateful Ingestion Config",
"default": {
"enabled": true,
"max_checkpoint_state_size": 16777216,
"state_provider": {
"type": "datahub",
"config": null
},
"ignore_old_state": false,
"ignore_new_state": false
},
"allOf": [
{
"$ref": "#/definitions/StatefulIngestionConfig"
}
]
},
"mysql_connection": {
"title": "Mysql Connection",
"description": "MySQL connection config",
"default": {
"username": null,
"host_port": "localhost:3306",
"database": null,
"database_alias": null,
"scheme": "mysql+pymysql",
"sqlalchemy_uri": null,
"options": {}
},
"allOf": [
{
"$ref": "#/definitions/MySQLConnectionConfig"
}
]
},
"kafka_connection": {
"title": "Kafka Connection",
"description": "Kafka connection config",
"default": {
"bootstrap": "localhost:9092",
"schema_registry_url": "http://localhost:8080/schema-registry/api/",
"schema_registry_config": {},
"client_timeout_seconds": 60,
"consumer_config": {}
},
"allOf": [
{
"$ref": "#/definitions/KafkaConsumerConnectionConfig"
}
]
},
"include_all_versions": {
"title": "Include All Versions",
"description": "If enabled, include all versions of each aspect. Otherwise, only include the latest version of each aspect.",
"default": false,
"type": "boolean"
},
"mysql_batch_size": {
"title": "Mysql Batch Size",
"description": "Number of records to fetch from MySQL at a time",
"default": 10000,
"type": "integer"
},
"mysql_table_name": {
"title": "Mysql Table Name",
"description": "Name of MySQL table containing all versioned aspects",
"default": "metadata_aspect_v2",
"type": "string"
},
"kafka_topic_name": {
"title": "Kafka Topic Name",
"description": "Name of kafka topic containing timeseries MCLs",
"default": "MetadataChangeLog_Timeseries_v1",
"type": "string"
},
"commit_state_interval": {
"title": "Commit State Interval",
"description": "Number of records to process before committing state",
"default": 1000,
"type": "integer"
},
"commit_with_parse_errors": {
"title": "Commit With Parse Errors",
"description": "Whether to update createdon timestamp and kafka offset despite parse errors. Enable if you want to ignore the errors.",
"default": false,
"type": "boolean"
}
}
},
"bigquery": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bigquery"
]
},
"config": {
"$ref": "#/definitions/bigquery_config"
}
},
"required": [
"type",
"config"
]
},
"bigquery_config": {
"title": "BigQueryV2Config",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"store_last_profiling_timestamps": {
"title": "Store Last Profiling Timestamps",
"description": "Enable storing last profile timestamp in store.",
"default": false,
"type": "boolean"
},
"incremental_lineage": {
"title": "Incremental Lineage",
"description": "When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.",
"default": true,
"type": "boolean"
},
"sql_parser_use_external_process": {
"title": "Sql Parser Use External Process",
"description": "When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.",
"default": false,
"type": "boolean"
},
"store_last_lineage_extraction_timestamp": {
"title": "Store Last Lineage Extraction Timestamp",
"description": "Enable checking last lineage extraction date in store.",
"default": false,
"type": "boolean"
},
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"store_last_usage_extraction_timestamp": {
"title": "Store Last Usage Extraction Timestamp",
"description": "Enable checking last usage timestamp in store.",
"default": true,
"type": "boolean"
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"rate_limit": {
"title": "Rate Limit",
"description": "Should we rate limit requests made to API.",
"default": false,
"type": "boolean"
},
"requests_per_min": {
"title": "Requests Per Min",
"description": "Used to control number of API calls made per min. Only used when `rate_limit` is set to `True`.",
"default": 60,
"type": "integer"
},
"temp_table_dataset_prefix": {
"title": "Temp Table Dataset Prefix",
"description": "If you are creating temp tables in a dataset with a particular prefix you can use this config to set the prefix for the dataset. This is to support workflows from before bigquery's introduction of temp tables. By default we use `_` because of datasets that begin with an underscore are hidden by default https://cloud.google.com/bigquery/docs/datasets#dataset-naming.",
"default": "_",
"type": "string"
},
"sharded_table_pattern": {
"title": "Sharded Table Pattern",
"description": "The regex pattern to match sharded tables and group as one table. This is a very low level config parameter, only change if you know what you are doing, ",
"default": "((.+)[_$])?(\\d{8})$",
"deprecated": true,
"type": "string"
},
"project_id_pattern": {
"title": "Project Id Pattern",
"description": "Regex patterns for project_id to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"usage": {
"title": "Usage",
"description": "Usage related configs",
"default": {
"bucket_duration": "DAY",
"end_time": "2023-08-15T22:02:13.573606+00:00",
"start_time": "2023-08-14T00:00:00+00:00",
"top_n_queries": 10,
"user_email_pattern": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"include_operational_stats": true,
"include_read_operational_stats": false,
"format_sql_queries": false,
"include_top_n_queries": true,
"max_query_duration": 900.0,
"apply_view_usage_to_tables": false
},
"allOf": [
{
"$ref": "#/definitions/BigQueryUsageConfig"
}
]
},
"include_usage_statistics": {
"title": "Include Usage Statistics",
"description": "Generate usage statistic",
"default": true,
"type": "boolean"
},
"capture_table_label_as_tag": {
"title": "Capture Table Label As Tag",
"description": "Capture BigQuery table labels as DataHub tag",
"default": false,
"type": "boolean"
},
"capture_dataset_label_as_tag": {
"title": "Capture Dataset Label As Tag",
"description": "Capture BigQuery dataset labels as DataHub tag",
"default": false,
"type": "boolean"
},
"dataset_pattern": {
"title": "Dataset Pattern",
"description": "Regex patterns for dataset to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"match_fully_qualified_names": {
"title": "Match Fully Qualified Names",
"description": "Whether `dataset_pattern` is matched against fully qualified dataset name `<project_id>.<dataset_name>`.",
"default": false,
"type": "boolean"
},
"include_external_url": {
"title": "Include External Url",
"description": "Whether to populate BigQuery Console url to Datasets/Tables",
"default": true,
"type": "boolean"
},
"debug_include_full_payloads": {
"title": "Debug Include Full Payloads",
"description": "Include full payload into events. It is only for debugging and internal use.",
"default": false,
"type": "boolean"
},
"number_of_datasets_process_in_batch_if_profiling_enabled": {
"title": "Number Of Datasets Process In Batch If Profiling Enabled",
"description": "Number of partitioned table queried in batch when getting metadata. This is a low level config property which should be touched with care. This restriction is needed because we query partitions system view which throws error if we try to touch too many tables.",
"default": 200,
"type": "integer"
},
"column_limit": {
"title": "Column Limit",
"description": "Maximum number of columns to process in a table. This is a low level config property which should be touched with care. This restriction is needed because excessively wide tables can result in failure to ingest the schema.",
"default": 300,
"type": "integer"
},
"project_id": {
"title": "Project Id",
"description": "[deprecated] Use project_id_pattern or project_ids instead.",
"type": "string"
},
"project_ids": {
"title": "Project Ids",
"description": "Ingests specified project_ids. Use this property if you want to specify what projects to ingest or don't want to give project resourcemanager.projects.list to your service account. Overrides `project_id_pattern`.",
"type": "array",
"items": {
"type": "string"
}
},
"project_on_behalf": {
"title": "Project On Behalf",
"description": "[Advanced] The BigQuery project in which queries are executed. Will be passed when creating a job. If not passed, falls back to the project associated with the service account.",
"type": "string"
},
"lineage_use_sql_parser": {
"title": "Lineage Use Sql Parser",
"description": "Use sql parser to resolve view/table lineage.",
"default": true,
"type": "boolean"
},
"lineage_parse_view_ddl": {
"title": "Lineage Parse View Ddl",
"description": "Sql parse view ddl to get lineage.",
"default": true,
"type": "boolean"
},
"lineage_sql_parser_use_raw_names": {
"title": "Lineage Sql Parser Use Raw Names",
"description": "This parameter ignores the lowercase pattern stipulated in the SQLParser. NOTE: Ignored if lineage_use_sql_parser is False.",
"default": false,
"type": "boolean"
},
"extract_column_lineage": {
"title": "Extract Column Lineage",
"description": "If enabled, generate column level lineage. Requires lineage_use_sql_parser to be enabled. This and `incremental_lineage` cannot both be enabled.",
"default": false,
"type": "boolean"
},
"extract_lineage_from_catalog": {
"title": "Extract Lineage From Catalog",
"description": "This flag enables the data lineage extraction from Data Lineage API exposed by Google Data Catalog. NOTE: This extractor can't build views lineage. It's recommended to enable the view's DDL parsing. Read the docs to have more information about: https://cloud.google.com/data-catalog/docs/concepts/about-data-lineage",
"default": false,
"type": "boolean"
},
"convert_urns_to_lowercase": {
"title": "Convert Urns To Lowercase",
"description": "Convert urns to lowercase.",
"default": false,
"type": "boolean"
},
"enable_legacy_sharded_table_support": {
"title": "Enable Legacy Sharded Table Support",
"description": "Use the legacy sharded table urn suffix added.",
"default": true,
"type": "boolean"
},
"scheme": {
"title": "Scheme",
"default": "bigquery",
"type": "string"
},
"log_page_size": {
"title": "Log Page Size",
"description": "The number of log item will be queried per page for lineage collection",
"default": 1000,
"exclusiveMinimum": 0,
"type": "integer"
},
"credential": {
"title": "Credential",
"description": "BigQuery credential informations",
"allOf": [
{
"$ref": "#/definitions/BigQueryCredential"
}
]
},
"extra_client_options": {
"title": "Extra Client Options",
"description": "Additional options to pass to google.cloud.logging_v2.client.Client.",
"default": {},
"type": "object"
},
"include_table_lineage": {
"title": "Include Table Lineage",
"description": "Option to enable/disable lineage generation. Is enabled by default.",
"default": true,
"type": "boolean"
},
"max_query_duration": {
"title": "Max Query Duration",
"description": "Correction to pad start_time and end_time with. For handling the case where the read happens within our time range but the query completion event is delayed and happens after the configured end time.",
"default": 900.0,
"type": "number",
"format": "time-delta"
},
"bigquery_audit_metadata_datasets": {
"title": "Bigquery Audit Metadata Datasets",
"description": "A list of datasets that contain a table named cloudaudit_googleapis_com_data_access which contain BigQuery audit logs, specifically, those containing BigQueryAuditMetadata. It is recommended that the project of the dataset is also specified, for example, projectA.datasetB.",
"type": "array",
"items": {
"type": "string"
}
},
"use_exported_bigquery_audit_metadata": {
"title": "Use Exported Bigquery Audit Metadata",
"description": "When configured, use BigQueryAuditMetadata in bigquery_audit_metadata_datasets to compute lineage information.",
"default": false,
"type": "boolean"
},
"use_date_sharded_audit_log_tables": {
"title": "Use Date Sharded Audit Log Tables",
"description": "Whether to read date sharded tables or time partitioned tables when extracting usage from exported audit logs.",
"default": false,
"type": "boolean"
},
"upstream_lineage_in_report": {
"title": "Upstream Lineage In Report",
"description": "Useful for debugging lineage information. Set to True to see the raw lineage created internally.",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"okta": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"okta"
]
},
"config": {
"$ref": "#/definitions/okta_config"
}
},
"required": [
"type",
"config"
]
},
"okta_config": {
"title": "OktaConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "Okta Stateful Ingestion Config.",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"okta_domain": {
"title": "Okta Domain",
"description": "The location of your Okta Domain, without a protocol. Can be found in Okta Developer console. e.g. dev-33231928.okta.com",
"type": "string"
},
"okta_api_token": {
"title": "Okta Api Token",
"description": "An API token generated for the DataHub application inside your Okta Developer Console. e.g. 00be4R_M2MzDqXawbWgfKGpKee0kuEOfX1RCQSRx00",
"type": "string"
},
"ingest_users": {
"title": "Ingest Users",
"description": "Whether users should be ingested into DataHub.",
"default": true,
"type": "boolean"
},
"ingest_groups": {
"title": "Ingest Groups",
"description": "Whether groups should be ingested into DataHub.",
"default": true,
"type": "boolean"
},
"ingest_group_membership": {
"title": "Ingest Group Membership",
"description": "Whether group membership should be ingested into DataHub. ingest_groups must be True if this is True.",
"default": true,
"type": "boolean"
},
"okta_profile_to_username_attr": {
"title": "Okta Profile To Username Attr",
"description": "Which Okta User Profile attribute to use as input to DataHub username mapping. Common values used are - login, email.",
"default": "email",
"type": "string"
},
"okta_profile_to_username_regex": {
"title": "Okta Profile To Username Regex",
"description": "A regex used to parse the DataHub username from the attribute specified in `okta_profile_to_username_attr`.",
"default": "(.*)",
"type": "string"
},
"okta_profile_to_group_name_attr": {
"title": "Okta Profile To Group Name Attr",
"description": "Which Okta Group Profile attribute to use as input to DataHub group name mapping.",
"default": "name",
"type": "string"
},
"okta_profile_to_group_name_regex": {
"title": "Okta Profile To Group Name Regex",
"description": "A regex used to parse the DataHub group name from the attribute specified in `okta_profile_to_group_name_attr`.",
"default": "(.*)",
"type": "string"
},
"include_deprovisioned_users": {
"title": "Include Deprovisioned Users",
"description": "Whether to ingest users in the DEPROVISIONED state from Okta.",
"default": false,
"type": "boolean"
},
"include_suspended_users": {
"title": "Include Suspended Users",
"description": "Whether to ingest users in the SUSPENDED state from Okta.",
"default": false,
"type": "boolean"
},
"page_size": {
"title": "Page Size",
"description": "The number of entities requested from Okta's REST APIs in one request.",
"default": 100,
"type": "integer"
},
"delay_seconds": {
"title": "Delay Seconds",
"description": "Number of seconds to wait between calls to Okta's REST APIs. (Okta rate limits). Defaults to 10ms.",
"default": 0.01,
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
}
]
},
"okta_users_filter": {
"title": "Okta Users Filter",
"description": "Okta filter expression (not regex) for ingesting users. Only one of `okta_users_filter` and `okta_users_search` can be set. See (https://developer.okta.com/docs/reference/api/users/#list-users-with-a-filter) for more info.",
"type": "string"
},
"okta_users_search": {
"title": "Okta Users Search",
"description": "Okta search expression (not regex) for ingesting users. Only one of `okta_users_filter` and `okta_users_search` can be set. See (https://developer.okta.com/docs/reference/api/users/#list-users-with-search) for more info.",
"type": "string"
},
"okta_groups_filter": {
"title": "Okta Groups Filter",
"description": "Okta filter expression (not regex) for ingesting groups. Only one of `okta_groups_filter` and `okta_groups_search` can be set. See (https://developer.okta.com/docs/reference/api/groups/#filters) for more info.",
"type": "string"
},
"okta_groups_search": {
"title": "Okta Groups Search",
"description": "Okta search expression (not regex) for ingesting groups. Only one of `okta_groups_filter` and `okta_groups_search` can be set. See (https://developer.okta.com/docs/reference/api/groups/#list-groups-with-search) for more info.",
"type": "string"
},
"mask_group_id": {
"title": "Mask Group Id",
"default": true,
"type": "boolean"
},
"mask_user_id": {
"title": "Mask User Id",
"default": true,
"type": "boolean"
}
},
"required": [
"okta_domain",
"okta_api_token"
],
"additionalProperties": false
},
"lookml": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"lookml"
]
},
"config": {
"$ref": "#/definitions/lookml_config"
}
},
"required": [
"type",
"config"
]
},
"lookml_config": {
"title": "LookMLSourceConfig",
"description": "Any source that is a primary producer of Dataset metadata should inherit this class",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"explore_naming_pattern": {
"title": "Explore Naming Pattern",
"description": "Pattern for providing dataset names to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']",
"default": {
"pattern": "{model}.explore.{name}"
},
"allOf": [
{
"$ref": "#/definitions/LookerNamingPattern"
}
]
},
"explore_browse_pattern": {
"title": "Explore Browse Pattern",
"description": "Pattern for providing browse paths to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']",
"default": {
"pattern": "/{env}/{platform}/{project}/explores"
},
"allOf": [
{
"$ref": "#/definitions/LookerNamingPattern"
}
]
},
"view_naming_pattern": {
"title": "View Naming Pattern",
"description": "Pattern for providing dataset names to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']",
"default": {
"pattern": "{project}.view.{name}"
},
"allOf": [
{
"$ref": "#/definitions/LookerNamingPattern"
}
]
},
"view_browse_pattern": {
"title": "View Browse Pattern",
"description": "Pattern for providing browse paths to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']",
"default": {
"pattern": "/{env}/{platform}/{project}/views"
},
"allOf": [
{
"$ref": "#/definitions/LookerNamingPattern"
}
]
},
"tag_measures_and_dimensions": {
"title": "Tag Measures And Dimensions",
"description": "When enabled, attaches tags to measures, dimensions and dimension groups to make them more discoverable. When disabled, adds this information to the description of the column.",
"default": true,
"type": "boolean"
},
"platform_name": {
"title": "Platform Name",
"description": "Default platform name. Don't change.",
"default": "looker",
"type": "string"
},
"extract_column_level_lineage": {
"title": "Extract Column Level Lineage",
"description": "When enabled, extracts column-level lineage from Views and Explores",
"default": true,
"type": "boolean"
},
"git_info": {
"title": "Git Info",
"description": "Reference to your git location. If present, supplies handy links to your lookml on the dataset entity page.",
"allOf": [
{
"$ref": "#/definitions/GitInfo"
}
]
},
"base_folder": {
"title": "Base Folder",
"description": "Required if not providing github configuration and deploy keys. A pointer to a local directory (accessible to the ingestion system) where the root of the LookML repo has been checked out (typically via a git clone). This is typically the root folder where the `*.model.lkml` and `*.view.lkml` files are stored. e.g. If you have checked out your LookML repo under `/Users/jdoe/workspace/my-lookml-repo`, then set `base_folder` to `/Users/jdoe/workspace/my-lookml-repo`.",
"format": "directory-path",
"type": "string"
},
"project_dependencies": {
"title": "Project Dependencies",
"description": "A map of project_name to local directory (accessible to the ingestion system) or Git credentials. Every local_dependencies or private remote_dependency listed in the main project's manifest.lkml file should have a corresponding entry here. If a deploy key is not provided, the ingestion system will use the same deploy key as the main project. ",
"default": {},
"type": "object",
"additionalProperties": {
"anyOf": [
{
"type": "string",
"format": "directory-path"
},
{
"$ref": "#/definitions/GitInfo"
}
]
}
},
"connection_to_platform_map": {
"title": "Connection To Platform Map",
"description": "A mapping of [Looker connection names](https://docs.looker.com/reference/model-params/connection-for-model) to DataHub platform, database, and schema values.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/LookerConnectionDefinition"
}
},
"model_pattern": {
"title": "Model Pattern",
"description": "List of regex patterns for LookML models to include in the extraction.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "List of regex patterns for LookML views to include in the extraction.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"parse_table_names_from_sql": {
"title": "Parse Table Names From Sql",
"description": "See note below.",
"default": false,
"type": "boolean"
},
"sql_parser": {
"title": "Sql Parser",
"description": "See note below.",
"default": "datahub.utilities.sql_parser.DefaultSQLParser",
"type": "string"
},
"api": {
"$ref": "#/definitions/LookerAPIConfig"
},
"project_name": {
"title": "Project Name",
"description": "Required if you don't specify the `api` section. The project name within which all the model files live. See (https://docs.looker.com/data-modeling/getting-started/how-project-works) to understand what the Looker project name should be. The simplest way to see your projects is to click on `Develop` followed by `Manage LookML Projects` in the Looker application.",
"type": "string"
},
"transport_options": {
"title": "Transport Options",
"description": "Populates the [TransportOptions](https://github.com/looker-open-source/sdk-codegen/blob/94d6047a0d52912ac082eb91616c1e7c379ab262/python/looker_sdk/rtl/transport.py#L70) struct for looker client",
"allOf": [
{
"$ref": "#/definitions/TransportOptionsConfig"
}
]
},
"max_file_snippet_length": {
"title": "Max File Snippet Length",
"description": "When extracting the view definition from a lookml file, the maximum number of characters to extract.",
"default": 512000,
"type": "integer"
},
"emit_reachable_views_only": {
"title": "Emit Reachable Views Only",
"description": "When enabled, only views that are reachable from explores defined in the model files are emitted",
"default": true,
"type": "boolean"
},
"populate_sql_logic_for_missing_descriptions": {
"title": "Populate Sql Logic For Missing Descriptions",
"description": "When enabled, field descriptions will include the sql logic for computed fields if descriptions are missing",
"default": false,
"type": "boolean"
},
"process_isolation_for_sql_parsing": {
"title": "Process Isolation For Sql Parsing",
"description": "When enabled, sql parsing will be executed in a separate process to prevent memory leaks.",
"default": false,
"type": "boolean"
},
"process_refinements": {
"title": "Process Refinements",
"description": "When enabled, looker refinement will be processed to adapt an existing view.",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"redshift": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"redshift"
]
},
"config": {
"$ref": "#/definitions/redshift_config"
}
},
"required": [
"type",
"config"
]
},
"redshift_config": {
"title": "RedshiftConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"store_last_profiling_timestamps": {
"title": "Store Last Profiling Timestamps",
"description": "Enable storing last profile timestamp in store.",
"default": false,
"type": "boolean"
},
"incremental_lineage": {
"title": "Incremental Lineage",
"description": "When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.",
"default": true,
"type": "boolean"
},
"sql_parser_use_external_process": {
"title": "Sql Parser Use External Process",
"description": "When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.",
"default": false,
"type": "boolean"
},
"store_last_lineage_extraction_timestamp": {
"title": "Store Last Lineage Extraction Timestamp",
"description": "Enable checking last lineage extraction date in store.",
"default": false,
"type": "boolean"
},
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"store_last_usage_extraction_timestamp": {
"title": "Store Last Usage Extraction Timestamp",
"description": "Enable checking last usage timestamp in store.",
"default": true,
"type": "boolean"
},
"top_n_queries": {
"title": "Top N Queries",
"description": "Number of top queries to save to each table.",
"default": 10,
"exclusiveMinimum": 0,
"type": "integer"
},
"user_email_pattern": {
"title": "User Email Pattern",
"description": "regex patterns for user emails to filter in usage.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_operational_stats": {
"title": "Include Operational Stats",
"description": "Whether to display operational stats.",
"default": true,
"type": "boolean"
},
"include_read_operational_stats": {
"title": "Include Read Operational Stats",
"description": "Whether to report read operational stats. Experimental.",
"default": false,
"type": "boolean"
},
"format_sql_queries": {
"title": "Format Sql Queries",
"description": "Whether to format sql queries",
"default": false,
"type": "boolean"
},
"include_top_n_queries": {
"title": "Include Top N Queries",
"description": "Whether to ingest the top_n_queries.",
"default": true,
"type": "boolean"
},
"email_domain": {
"title": "Email Domain",
"description": "Email domain of your organisation so users can be displayed on UI appropriately.",
"type": "string"
},
"s3_lineage_config": {
"title": "S3 Lineage Config",
"description": "Common config for S3 lineage generation",
"default": {
"path_specs": [],
"strip_urls": true
},
"allOf": [
{
"$ref": "#/definitions/S3LineageProviderConfig"
}
]
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "A holder for platform -> platform_instance mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"default": {
"allow": [
".*"
],
"deny": [
"information_schema"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database",
"default": "dev",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"default": "redshift+psycopg2",
"hidden_from_schema": true,
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"default_schema": {
"title": "Default Schema",
"description": "The default schema to use if the sql parser fails to parse the schema with `sql_based` lineage collector",
"default": "public",
"type": "string"
},
"include_table_lineage": {
"title": "Include Table Lineage",
"description": "Whether table lineage should be ingested.",
"default": true,
"type": "boolean"
},
"include_copy_lineage": {
"title": "Include Copy Lineage",
"description": "Whether lineage should be collected from copy commands",
"default": true,
"type": "boolean"
},
"include_usage_statistics": {
"title": "Include Usage Statistics",
"description": "Generate usage statistic. email_domain config parameter needs to be set if enabled",
"default": false,
"type": "boolean"
},
"include_unload_lineage": {
"title": "Include Unload Lineage",
"description": "Whether lineage should be collected from unload commands",
"default": true,
"type": "boolean"
},
"capture_lineage_query_parser_failures": {
"title": "Capture Lineage Query Parser Failures",
"description": "Whether to capture lineage query parser errors with dataset properties for debugging",
"default": false,
"hide_from_schema": true,
"type": "boolean"
},
"table_lineage_mode": {
"description": "Which table lineage collector mode to use. Available modes are: [stl_scan_based, sql_based, mixed]",
"default": "stl_scan_based",
"allOf": [
{
"$ref": "#/definitions/LineageMode"
}
]
},
"extra_client_options": {
"title": "Extra Client Options",
"default": {},
"type": "object"
},
"match_fully_qualified_names": {
"title": "Match Fully Qualified Names",
"description": "Whether `schema_pattern` is matched against fully qualified schema name `<database>.<schema>`.",
"default": false,
"type": "boolean"
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"redshift-usage-legacy": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"redshift-usage-legacy"
]
},
"config": {
"$ref": "#/definitions/redshift-usage-legacy_config"
}
},
"required": [
"type",
"config"
]
},
"redshift-usage-legacy_config": {
"title": "RedshiftUsageConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"top_n_queries": {
"title": "Top N Queries",
"description": "Number of top queries to save to each table.",
"default": 10,
"exclusiveMinimum": 0,
"type": "integer"
},
"user_email_pattern": {
"title": "User Email Pattern",
"description": "regex patterns for user emails to filter in usage.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_operational_stats": {
"title": "Include Operational Stats",
"description": "Whether to display operational stats.",
"default": true,
"type": "boolean"
},
"include_read_operational_stats": {
"title": "Include Read Operational Stats",
"description": "Whether to report read operational stats. Experimental.",
"default": false,
"type": "boolean"
},
"format_sql_queries": {
"title": "Format Sql Queries",
"description": "Whether to format sql queries",
"default": false,
"type": "boolean"
},
"include_top_n_queries": {
"title": "Include Top N Queries",
"description": "Whether to ingest the top_n_queries.",
"default": true,
"type": "boolean"
},
"s3_lineage_config": {
"title": "S3 Lineage Config",
"description": "Common config for S3 lineage generation",
"allOf": [
{
"$ref": "#/definitions/S3LineageProviderConfig"
}
]
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "A holder for platform -> platform_instance mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to SQLAlchemy's create_engine as kwargs.See https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine for details.",
"default": {},
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"default": {
"allow": [
".*"
],
"deny": [
"information_schema"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"default_schema": {
"title": "Default Schema",
"description": "The default schema to use if the sql parser fails to parse the schema with `sql_based` lineage collector",
"default": "public",
"type": "string"
},
"include_table_lineage": {
"title": "Include Table Lineage",
"description": "Whether table lineage should be ingested.",
"default": true,
"type": "boolean"
},
"include_copy_lineage": {
"title": "Include Copy Lineage",
"description": "Whether lineage should be collected from copy commands",
"default": true,
"type": "boolean"
},
"include_unload_lineage": {
"title": "Include Unload Lineage",
"description": "Whether lineage should be collected from unload commands",
"default": true,
"type": "boolean"
},
"capture_lineage_query_parser_failures": {
"title": "Capture Lineage Query Parser Failures",
"description": "Whether to capture lineage query parser errors with dataset properties for debuggings",
"default": false,
"type": "boolean"
},
"table_lineage_mode": {
"description": "Which table lineage collector mode to use. Available modes are: [stl_scan_based, sql_based, mixed]",
"default": "stl_scan_based",
"allOf": [
{
"$ref": "#/definitions/LineageMode"
}
]
},
"email_domain": {
"title": "Email Domain",
"description": "Email domain of your organisation so users can be displayed on UI appropriately.",
"type": "string"
}
},
"required": [
"host_port",
"email_domain"
],
"additionalProperties": false
},
"demo-data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"demo-data"
]
},
"config": {
"$ref": "#/definitions/demo-data_config"
}
},
"required": [
"type",
"config"
]
},
"demo-data_config": {
"title": "DemoDataConfig",
"type": "object",
"properties": {},
"additionalProperties": false
},
"vertica": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"vertica"
]
},
"config": {
"$ref": "#/definitions/vertica_config"
}
},
"required": [
"type",
"config"
]
},
"vertica_config": {
"title": "VerticaConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"default": "vertica+vertica_python",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"models_pattern": {
"title": "Models Pattern",
"description": "Regex patterns for ml models to filter in ingestion. ",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_projections": {
"title": "Include Projections",
"description": "Whether projections should be ingested.",
"default": true,
"type": "boolean"
},
"include_models": {
"title": "Include Models",
"description": "Whether Models should be ingested.",
"default": true,
"type": "boolean"
},
"include_view_lineage": {
"title": "Include View Lineage",
"description": "If the source supports it, include view lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"include_projection_lineage": {
"title": "Include Projection Lineage",
"description": "If the source supports it, include view lineage to the underlying storage location.",
"default": true,
"type": "boolean"
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"redash": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"redash"
]
},
"config": {
"$ref": "#/definitions/redash_config"
}
},
"required": [
"type",
"config"
]
},
"redash_config": {
"title": "RedashConfig",
"type": "object",
"properties": {
"connect_uri": {
"title": "Connect Uri",
"description": "Redash base URL.",
"default": "http://localhost:5000",
"type": "string"
},
"api_key": {
"title": "Api Key",
"description": "Redash user API key.",
"default": "REDASH_API_KEY",
"type": "string"
},
"dashboard_patterns": {
"title": "Dashboard Patterns",
"description": "regex patterns for dashboards to filter for ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"chart_patterns": {
"title": "Chart Patterns",
"description": "regex patterns for charts to filter for ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"skip_draft": {
"title": "Skip Draft",
"description": "Only ingest published dashboards and charts.",
"default": true,
"type": "boolean"
},
"page_size": {
"title": "Page Size",
"description": "Limit on number of items to be queried at once.",
"default": 25,
"type": "integer"
},
"api_page_limit": {
"title": "Api Page Limit",
"description": "Limit on number of pages queried for ingesting dashboards and charts API during pagination.",
"default": 9223372036854775807,
"type": "integer"
},
"parallelism": {
"title": "Parallelism",
"description": "Parallelism to use while processing.",
"default": 1,
"type": "integer"
},
"parse_table_names_from_sql": {
"title": "Parse Table Names From Sql",
"description": "See note below.",
"default": false,
"type": "boolean"
},
"sql_parser": {
"title": "Sql Parser",
"description": "custom SQL parser. See note below for details.",
"default": "datahub.utilities.sql_parser.DefaultSQLParser",
"type": "string"
},
"env": {
"title": "Env",
"description": "Environment to use in namespace when constructing URNs.",
"default": "PROD",
"type": "string"
}
},
"additionalProperties": false
},
"dbt": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dbt"
]
},
"config": {
"$ref": "#/definitions/dbt_config"
}
},
"required": [
"type",
"config"
]
},
"dbt_config": {
"title": "DBTCoreConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"incremental_lineage": {
"title": "Incremental Lineage",
"description": "When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.",
"default": true,
"type": "boolean"
},
"sql_parser_use_external_process": {
"title": "Sql Parser Use External Process",
"description": "When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.",
"default": false,
"type": "boolean"
},
"env": {
"title": "Env",
"description": "Environment to use in namespace when constructing URNs.",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "DBT Stateful Ingestion Config.",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"target_platform": {
"title": "Target Platform",
"description": "The platform that dbt is loading onto. (e.g. bigquery / redshift / postgres etc.)",
"type": "string"
},
"target_platform_instance": {
"title": "Target Platform Instance",
"description": "The platform instance for the platform that dbt is operating on. Use this if you have multiple instances of the same platform (e.g. redshift) and need to distinguish between them.",
"type": "string"
},
"use_identifiers": {
"title": "Use Identifiers",
"description": "Use model identifier instead of model name if defined (if not, default to model name).",
"default": false,
"type": "boolean"
},
"entities_enabled": {
"title": "Entities Enabled",
"description": "Controls for enabling / disabling metadata emission for different dbt entities (models, test definitions, test results, etc.)",
"default": {
"models": "YES",
"sources": "YES",
"seeds": "YES",
"snapshots": "YES",
"test_definitions": "YES",
"test_results": "YES"
},
"allOf": [
{
"$ref": "#/definitions/DBTEntitiesEnabled"
}
]
},
"tag_prefix": {
"title": "Tag Prefix",
"description": "Prefix added to tags during ingestion.",
"default": "dbt:",
"type": "string"
},
"node_name_pattern": {
"title": "Node Name Pattern",
"description": "regex patterns for dbt model names to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"meta_mapping": {
"title": "Meta Mapping",
"description": "mapping rules that will be executed against dbt meta properties. Refer to the section below on dbt meta automated mappings.",
"default": {},
"type": "object"
},
"column_meta_mapping": {
"title": "Column Meta Mapping",
"description": "mapping rules that will be executed against dbt column meta properties. Refer to the section below on dbt meta automated mappings.",
"default": {},
"type": "object"
},
"query_tag_mapping": {
"title": "Query Tag Mapping",
"description": "mapping rules that will be executed against dbt query_tag meta properties. Refer to the section below on dbt meta automated mappings.",
"default": {},
"type": "object"
},
"write_semantics": {
"title": "Write Semantics",
"description": "Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be \"PATCH\" or \"OVERRIDE\"",
"default": "PATCH",
"type": "string"
},
"strip_user_ids_from_email": {
"title": "Strip User Ids From Email",
"description": "Whether or not to strip email id while adding owners using dbt meta actions.",
"default": false,
"type": "boolean"
},
"enable_owner_extraction": {
"title": "Enable Owner Extraction",
"description": "When enabled, ownership info will be extracted from the dbt meta",
"default": true,
"type": "boolean"
},
"owner_extraction_pattern": {
"title": "Owner Extraction Pattern",
"description": "Regex string to extract owner from the dbt node using the `(?P<name>...) syntax` of the [match object](https://docs.python.org/3/library/re.html#match-objects), where the group name must be `owner`. Examples: (1)`r\"(?P<owner>(.*)): (\\w+) (\\w+)\"` will extract `jdoe` as the owner from `\"jdoe: John Doe\"` (2) `r\"@(?P<owner>(.*))\"` will extract `alice` as the owner from `\"@alice\"`.",
"type": "string"
},
"include_env_in_assertion_guid": {
"title": "Include Env In Assertion Guid",
"description": "Prior to version 0.9.4.2, the assertion GUIDs did not include the environment. If you're using multiple dbt ingestion that are only distinguished by env, then you should set this flag to True.",
"default": false,
"type": "boolean"
},
"convert_column_urns_to_lowercase": {
"title": "Convert Column Urns To Lowercase",
"description": "When enabled, converts column URNs to lowercase to ensure cross-platform compatibility. If `target_platform` is Snowflake, the default is True.",
"default": false,
"type": "boolean"
},
"enable_meta_mapping": {
"title": "Enable Meta Mapping",
"description": "When enabled, applies the mappings that are defined through the meta_mapping directives.",
"default": true,
"type": "boolean"
},
"enable_query_tag_mapping": {
"title": "Enable Query Tag Mapping",
"description": "When enabled, applies the mappings that are defined through the `query_tag_mapping` directives.",
"default": true,
"type": "boolean"
},
"manifest_path": {
"title": "Manifest Path",
"description": "Path to dbt manifest JSON. See https://docs.getdbt.com/reference/artifacts/manifest-json Note this can be a local file or a URI.",
"type": "string"
},
"catalog_path": {
"title": "Catalog Path",
"description": "Path to dbt catalog JSON. See https://docs.getdbt.com/reference/artifacts/catalog-json Note this can be a local file or a URI.",
"type": "string"
},
"sources_path": {
"title": "Sources Path",
"description": "Path to dbt sources JSON. See https://docs.getdbt.com/reference/artifacts/sources-json. If not specified, last-modified fields will not be populated. Note this can be a local file or a URI.",
"type": "string"
},
"test_results_path": {
"title": "Test Results Path",
"description": "Path to output of dbt test run as run_results file in JSON format. See https://docs.getdbt.com/reference/artifacts/run-results-json. If not specified, test execution results will not be populated in DataHub.",
"type": "string"
},
"aws_connection": {
"title": "Aws Connection",
"description": "When fetching manifest files from s3, configuration for aws connection details",
"allOf": [
{
"$ref": "#/definitions/AwsConnectionConfig"
}
]
},
"git_info": {
"title": "Git Info",
"description": "Reference to your git location to enable easy navigation from DataHub to your dbt files.",
"allOf": [
{
"$ref": "#/definitions/GitReference"
}
]
}
},
"required": [
"target_platform",
"manifest_path",
"catalog_path"
],
"additionalProperties": false
},
"presto-on-hive": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"presto-on-hive"
]
},
"config": {
"$ref": "#/definitions/presto-on-hive_config"
}
},
"required": [
"type",
"config"
]
},
"presto-on-hive_config": {
"title": "PrestoOnHiveConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "Host URL and port to connect to. Example: localhost:3306",
"default": "localhost:3306",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"views_where_clause_suffix": {
"title": "Views Where Clause Suffix",
"description": "Where clause to specify what Presto views should be ingested.",
"default": "",
"type": "string"
},
"tables_where_clause_suffix": {
"title": "Tables Where Clause Suffix",
"description": "Where clause to specify what Hive tables should be ingested.",
"default": "",
"type": "string"
},
"schemas_where_clause_suffix": {
"title": "Schemas Where Clause Suffix",
"description": "Where clause to specify what Hive schemas should be ingested.",
"default": "",
"type": "string"
},
"ingestion_job_id": {
"title": "Ingestion Job Id",
"default": "",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "Regex patterns for hive/presto database to filter in ingestion. Specify regex to only match the database name. e.g. to match all tables in database analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"metastore_db_name": {
"title": "Metastore Db Name",
"description": "Name of the Hive metastore's database (usually: metastore). For backward compatibility, if this field is not provided, the database field will be used. If both the 'database' and 'metastore_db_name' fields are set then the 'database' field will be used to filter the hive/presto/trino database",
"type": "string"
},
"mode": {
"description": "The ingested data will be stored under this platform. Valid options: ['hive', 'presto', 'presto-on-hive', 'trino']",
"default": "presto-on-hive",
"allOf": [
{
"$ref": "#/definitions/PrestoOnHiveConfigMode"
}
]
},
"use_catalog_subtype": {
"title": "Use Catalog Subtype",
"description": "Container Subtype name to be 'Database' or 'Catalog' Valid options: ['True', 'False']",
"default": true,
"type": "boolean"
},
"use_dataset_pascalcase_subtype": {
"title": "Use Dataset Pascalcase Subtype",
"description": "Dataset Subtype name to be 'Table' or 'View' Valid options: ['True', 'False']",
"default": false,
"type": "boolean"
},
"include_catalog_name_in_ids": {
"title": "Include Catalog Name In Ids",
"description": "Add the Presto catalog name (e.g. hive) to the generated dataset urns. `urn:li:dataset:(urn:li:dataPlatform:hive,hive.user.logging_events,PROD)` versus `urn:li:dataset:(urn:li:dataPlatform:hive,user.logging_events,PROD)`",
"default": false,
"type": "boolean"
},
"enable_properties_merge": {
"title": "Enable Properties Merge",
"description": "By default, the connector overwrites properties every time. Set this to True to enable merging of properties with what exists on the server.",
"default": false,
"type": "boolean"
},
"simplify_nested_field_paths": {
"title": "Simplify Nested Field Paths",
"description": "Simplify v2 field paths to v1 by default. If the schema has Union or Array types, still falls back to v2",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"powerbi": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"powerbi"
]
},
"config": {
"$ref": "#/definitions/powerbi_config"
}
},
"required": [
"type",
"config"
]
},
"powerbi_config": {
"title": "PowerBiDashboardSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "PowerBI Stateful Ingestion Config.",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"tenant_id": {
"title": "Tenant Id",
"description": "PowerBI tenant identifier",
"type": "string"
},
"workspace_id_pattern": {
"title": "Workspace Id Pattern",
"description": "Regex patterns to filter PowerBI workspaces in ingestion",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"server_to_platform_instance": {
"title": "Server To Platform Instance",
"description": "A mapping of PowerBI datasource's server i.e host[:port] to Data platform instance. :port is optional and only needed if your datasource server is running on non-standard port.For Google BigQuery the datasource's server is google bigquery project name",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/PlatformDetail"
}
},
"client_id": {
"title": "Client Id",
"description": "Azure app client identifier",
"type": "string"
},
"client_secret": {
"title": "Client Secret",
"description": "Azure app client secret",
"type": "string"
},
"scan_timeout": {
"title": "Scan Timeout",
"description": "timeout for PowerBI metadata scanning",
"default": 60,
"type": "integer"
},
"scan_batch_size": {
"title": "Scan Batch Size",
"description": "batch size for sending workspace_ids to PBI, 100 is the limit",
"default": 1,
"exclusiveMinimum": 0,
"maximum": 100,
"type": "integer"
},
"workspace_id_as_urn_part": {
"title": "Workspace Id As Urn Part",
"description": "Highly recommend changing this to True, as you can have the same workspace nameTo maintain backward compatability, this is set to False which uses workspace name",
"default": false,
"type": "boolean"
},
"extract_ownership": {
"title": "Extract Ownership",
"description": "Whether ownership should be ingested. Admin API access is required if this setting is enabled. Note that enabling this may overwrite owners that you've added inside DataHub's web application.",
"default": false,
"type": "boolean"
},
"extract_reports": {
"title": "Extract Reports",
"description": "Whether reports should be ingested",
"default": true,
"type": "boolean"
},
"ownership": {
"title": "Ownership",
"description": "Configure how is ownership ingested",
"default": {
"create_corp_user": true,
"use_powerbi_email": false,
"remove_email_suffix": false,
"dataset_configured_by_as_owner": false,
"owner_criteria": null
},
"allOf": [
{
"$ref": "#/definitions/OwnershipMapping"
}
]
},
"modified_since": {
"title": "Modified Since",
"description": "Get only recently modified workspaces based on modified_since datetime '2023-02-10T00:00:00.0000000Z', excludePersonalWorkspaces and excludeInActiveWorkspaces limit to last 30 days",
"type": "string"
},
"extract_dashboards": {
"title": "Extract Dashboards",
"description": "Whether to ingest PBI Dashboard and Tiles as Datahub Dashboard and Chart",
"default": true,
"type": "boolean"
},
"extract_dataset_schema": {
"title": "Extract Dataset Schema",
"description": "Whether to ingest PBI Dataset Table columns and measures",
"default": false,
"type": "boolean"
},
"extract_lineage": {
"title": "Extract Lineage",
"description": "Whether lineage should be ingested between X and Y. Admin API access is required if this setting is enabled",
"default": true,
"type": "boolean"
},
"extract_endorsements_to_tags": {
"title": "Extract Endorsements To Tags",
"description": "Whether to extract endorsements to tags, note that this may overwrite existing tags. Admin API access is required is this setting is enabled",
"default": false,
"type": "boolean"
},
"filter_dataset_endorsements": {
"title": "Filter Dataset Endorsements",
"description": "Filter and ingest datasets which are 'Certified' or 'Promoted' endorsement. If both are added, dataset which are 'Certified' or 'Promoted' will be ingested . Default setting allows all dataset to be ingested",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"extract_workspaces_to_containers": {
"title": "Extract Workspaces To Containers",
"description": "Extract workspaces to DataHub containers",
"default": true,
"type": "boolean"
},
"extract_datasets_to_containers": {
"title": "Extract Datasets To Containers",
"description": "PBI tables will be grouped under a Datahub Container, the container reflect a PBI Dataset",
"default": false,
"type": "boolean"
},
"native_query_parsing": {
"title": "Native Query Parsing",
"description": "Whether PowerBI native query should be parsed to extract lineage",
"default": true,
"type": "boolean"
},
"convert_urns_to_lowercase": {
"title": "Convert Urns To Lowercase",
"description": "Whether to convert the PowerBI assets urns to lowercase",
"default": false,
"type": "boolean"
},
"convert_lineage_urns_to_lowercase": {
"title": "Convert Lineage Urns To Lowercase",
"description": "Whether to convert the urns of ingested lineage dataset to lowercase",
"default": true,
"type": "boolean"
},
"admin_apis_only": {
"title": "Admin Apis Only",
"description": "Retrieve metadata using PowerBI Admin API only. If this is enabled, then Report Pages will not be extracted. Admin API access is required if this setting is enabled",
"default": false,
"type": "boolean"
},
"extract_independent_datasets": {
"title": "Extract Independent Datasets",
"description": "Whether to extract datasets not used in any PowerBI visualization",
"default": false,
"type": "boolean"
}
},
"required": [
"tenant_id",
"client_id",
"client_secret"
],
"additionalProperties": false
},
"elasticsearch": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"elasticsearch"
]
},
"config": {
"$ref": "#/definitions/elasticsearch_config"
}
},
"required": [
"type",
"config"
]
},
"elasticsearch_config": {
"title": "ElasticsearchSourceConfig",
"description": "Any source that connects to a platform should inherit this class",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"host": {
"title": "Host",
"description": "The elastic search host URI.",
"default": "localhost:9200",
"type": "string"
},
"username": {
"title": "Username",
"description": "The username credential.",
"type": "string"
},
"password": {
"title": "Password",
"description": "The password credential.",
"type": "string"
},
"use_ssl": {
"title": "Use Ssl",
"description": "Whether to use SSL for the connection or not.",
"default": false,
"type": "boolean"
},
"verify_certs": {
"title": "Verify Certs",
"description": "Whether to verify SSL certificates.",
"default": false,
"type": "boolean"
},
"ca_certs": {
"title": "Ca Certs",
"description": "Path to a certificate authority (CA) certificate.",
"type": "string"
},
"client_cert": {
"title": "Client Cert",
"description": "Path to the file containing the private key and the certificate, or cert only if using client_key.",
"type": "string"
},
"client_key": {
"title": "Client Key",
"description": "Path to the file containing the private key if using separate cert and key files.",
"type": "string"
},
"ssl_assert_hostname": {
"title": "Ssl Assert Hostname",
"description": "Use hostname verification if not False.",
"default": false,
"type": "boolean"
},
"ssl_assert_fingerprint": {
"title": "Ssl Assert Fingerprint",
"description": "Verify the supplied certificate fingerprint if not None.",
"type": "string"
},
"url_prefix": {
"title": "Url Prefix",
"description": "There are cases where an enterprise would have multiple elastic search clusters. One way for them to manage is to have a single endpoint for all the elastic search clusters and use url_prefix for routing requests to different clusters.",
"default": "",
"type": "string"
},
"index_pattern": {
"title": "Index Pattern",
"description": "regex patterns for indexes to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [
"^_.*",
"^ilm-history.*"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"ingest_index_templates": {
"title": "Ingest Index Templates",
"description": "Ingests ES index templates if enabled.",
"default": false,
"type": "boolean"
},
"index_template_pattern": {
"title": "Index Template Pattern",
"description": "The regex patterns for filtering index templates to ingest.",
"default": {
"allow": [
".*"
],
"deny": [
"^_.*"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profiling": {
"$ref": "#/definitions/ElasticProfiling"
},
"collapse_urns": {
"$ref": "#/definitions/CollapseUrns"
}
},
"additionalProperties": false
},
"snowflake": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"snowflake"
]
},
"config": {
"$ref": "#/definitions/snowflake_config"
}
},
"required": [
"type",
"config"
]
},
"snowflake_config": {
"title": "SnowflakeV2Config",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"classification": {
"title": "Classification",
"description": "For details, refer [Classification](../../../../metadata-ingestion/docs/dev_guides/classification.md).",
"default": {
"enabled": false,
"sample_size": 100,
"max_workers": 2,
"table_pattern": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"column_pattern": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"info_type_to_term": {},
"classifiers": [
{
"type": "datahub",
"config": null
}
]
},
"allOf": [
{
"$ref": "#/definitions/ClassificationConfig"
}
]
},
"store_last_profiling_timestamps": {
"title": "Store Last Profiling Timestamps",
"description": "Enable storing last profile timestamp in store.",
"default": false,
"type": "boolean"
},
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"store_last_usage_extraction_timestamp": {
"title": "Store Last Usage Extraction Timestamp",
"description": "Enable checking last usage timestamp in store.",
"default": true,
"type": "boolean"
},
"top_n_queries": {
"title": "Top N Queries",
"description": "Number of top queries to save to each table.",
"default": 10,
"exclusiveMinimum": 0,
"type": "integer"
},
"user_email_pattern": {
"title": "User Email Pattern",
"description": "regex patterns for user emails to filter in usage.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_operational_stats": {
"title": "Include Operational Stats",
"description": "Whether to display operational stats.",
"default": true,
"type": "boolean"
},
"include_read_operational_stats": {
"title": "Include Read Operational Stats",
"description": "Whether to report read operational stats. Experimental.",
"default": false,
"type": "boolean"
},
"format_sql_queries": {
"title": "Format Sql Queries",
"description": "Whether to format sql queries",
"default": false,
"type": "boolean"
},
"include_top_n_queries": {
"title": "Include Top N Queries",
"description": "Whether to ingest the top_n_queries.",
"default": true,
"type": "boolean"
},
"email_domain": {
"title": "Email Domain",
"description": "Email domain of your organisation so users can be displayed on UI appropriately.",
"type": "string"
},
"apply_view_usage_to_tables": {
"title": "Apply View Usage To Tables",
"description": "Whether to apply view's usage to its base tables. If set to True, usage is applied to base tables only.",
"default": false,
"type": "boolean"
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"scheme": {
"title": "Scheme",
"default": "snowflake",
"type": "string"
},
"username": {
"title": "Username",
"description": "Snowflake username.",
"type": "string"
},
"password": {
"title": "Password",
"description": "Snowflake password.",
"type": "string",
"writeOnly": true,
"format": "password"
},
"private_key": {
"title": "Private Key",
"description": "Private key in a form of '-----BEGIN PRIVATE KEY-----\\nprivate-key\\n-----END PRIVATE KEY-----\\n' if using key pair authentication. Encrypted version of private key will be in a form of '-----BEGIN ENCRYPTED PRIVATE KEY-----\\nencrypted-private-key\\n-----END ECNCRYPTED PRIVATE KEY-----\\n' See: https://docs.snowflake.com/en/user-guide/key-pair-auth.html",
"type": "string"
},
"private_key_path": {
"title": "Private Key Path",
"description": "The path to the private key if using key pair authentication. Ignored if `private_key` is set. See: https://docs.snowflake.com/en/user-guide/key-pair-auth.html",
"type": "string"
},
"private_key_password": {
"title": "Private Key Password",
"description": "Password for your private key. Required if using key pair authentication with encrypted private key.",
"type": "string",
"writeOnly": true,
"format": "password"
},
"oauth_config": {
"title": "Oauth Config",
"description": "oauth configuration - https://docs.snowflake.com/en/user-guide/python-connector-example.html#connecting-with-oauth",
"allOf": [
{
"$ref": "#/definitions/OAuthConfiguration"
}
]
},
"authentication_type": {
"title": "Authentication Type",
"description": "The type of authenticator to use when connecting to Snowflake. Supports \"DEFAULT_AUTHENTICATOR\", \"OAUTH_AUTHENTICATOR\", \"EXTERNAL_BROWSER_AUTHENTICATOR\" and \"KEY_PAIR_AUTHENTICATOR\".",
"default": "DEFAULT_AUTHENTICATOR",
"type": "string"
},
"account_id": {
"title": "Account Id",
"description": "Snowflake account identifier. e.g. xy12345, xy12345.us-east-2.aws, xy12345.us-central1.gcp, xy12345.central-us.azure, xy12345.us-west-2.privatelink. Refer [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html#format-2-legacy-account-locator-in-a-region) for more details.",
"type": "string"
},
"warehouse": {
"title": "Warehouse",
"description": "Snowflake warehouse.",
"type": "string"
},
"role": {
"title": "Role",
"description": "Snowflake role.",
"type": "string"
},
"include_table_lineage": {
"title": "Include Table Lineage",
"description": "If enabled, populates the snowflake table-to-table and s3-to-snowflake table lineage. Requires appropriate grants given to the role and Snowflake Enterprise Edition or above.",
"default": true,
"type": "boolean"
},
"include_view_lineage": {
"title": "Include View Lineage",
"description": "If enabled, populates the snowflake view->table and table->view lineages. Requires appropriate grants given to the role, and include_table_lineage to be True. view->table lineage requires Snowflake Enterprise Edition or above.",
"default": true,
"type": "boolean"
},
"connect_args": {
"title": "Connect Args",
"description": "Connect args to pass to Snowflake SqlAlchemy driver",
"type": "object"
},
"database_pattern": {
"title": "Database Pattern",
"default": {
"allow": [
".*"
],
"deny": [
"^UTIL_DB$",
"^SNOWFLAKE$",
"^SNOWFLAKE_SAMPLE_DATA$"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"ignore_start_time_lineage": {
"title": "Ignore Start Time Lineage",
"default": false,
"type": "boolean"
},
"upstream_lineage_in_report": {
"title": "Upstream Lineage In Report",
"default": false,
"type": "boolean"
},
"convert_urns_to_lowercase": {
"title": "Convert Urns To Lowercase",
"default": true,
"type": "boolean"
},
"include_usage_stats": {
"title": "Include Usage Stats",
"description": "If enabled, populates the snowflake usage statistics. Requires appropriate grants given to the role.",
"default": true,
"type": "boolean"
},
"include_technical_schema": {
"title": "Include Technical Schema",
"description": "If enabled, populates the snowflake technical schema and descriptions.",
"default": true,
"type": "boolean"
},
"include_column_lineage": {
"title": "Include Column Lineage",
"description": "Populates table->table and view->table column lineage. Requires appropriate grants given to the role and the Snowflake Enterprise Edition or above.",
"default": true,
"type": "boolean"
},
"include_view_column_lineage": {
"title": "Include View Column Lineage",
"description": "Populates view->view and table->view column lineage.",
"default": false,
"type": "boolean"
},
"extract_tags": {
"description": "Optional. Allowed values are `without_lineage`, `with_lineage`, and `skip` (default). `without_lineage` only extracts tags that have been applied directly to the given entity. `with_lineage` extracts both directly applied and propagated tags, but will be significantly slower. See the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/object-tagging.html#tag-lineage) for information about tag lineage/propagation. ",
"default": "skip",
"allOf": [
{
"$ref": "#/definitions/TagOption"
}
]
},
"include_external_url": {
"title": "Include External Url",
"description": "Whether to populate Snowsight url for Snowflake Objects",
"default": true,
"type": "boolean"
},
"match_fully_qualified_names": {
"title": "Match Fully Qualified Names",
"description": "Whether `schema_pattern` is matched against fully qualified schema name `<catalog>.<schema>`.",
"default": false,
"type": "boolean"
},
"use_legacy_lineage_method": {
"title": "Use Legacy Lineage Method",
"description": "Whether to use the legacy lineage computation method. By default, uses new optimised lineage extraction method that requires less ingestion process memory. Table-to-view and view-to-view column-level lineage are not supported with the legacy method.",
"default": false,
"type": "boolean"
},
"validate_upstreams_against_patterns": {
"title": "Validate Upstreams Against Patterns",
"description": "Whether to validate upstream snowflake tables against allow-deny patterns",
"default": true,
"type": "boolean"
},
"tag_pattern": {
"title": "Tag Pattern",
"description": "List of regex patterns for tags to include in ingestion. Only used if `extract_tags` is enabled.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"temporary_tables_pattern": {
"title": "Temporary Tables Pattern",
"description": "[Advanced] Regex patterns for temporary tables to filter in lineage ingestion. Specify regex to match the entire table name in database.schema.table format. Defaults are to set in such a way to ignore the temporary staging tables created by known ETL tools. Not used if `use_legacy_lineage_method=True`",
"default": [
".*\\.FIVETRAN_.*_STAGING\\..*",
".*__DBT_TMP$",
".*\\.SEGMENT_[a-f0-9]{8}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{12}",
".*\\.STAGING_.*_[a-f0-9]{8}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{12}"
],
"type": "array",
"items": {
"type": "string"
}
},
"email_as_user_identifier": {
"title": "Email As User Identifier",
"description": "Format user urns as an email, if the snowflake user's email is set. If `email_domain` is provided, generates email addresses for snowflake users with unset emails, based on their username.",
"default": true,
"type": "boolean"
}
},
"required": [
"account_id"
],
"additionalProperties": false
},
"superset": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"superset"
]
},
"config": {
"$ref": "#/definitions/superset_config"
}
},
"required": [
"type",
"config"
]
},
"superset_config": {
"title": "SupersetConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "Superset Stateful Ingestion Config.",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"connect_uri": {
"title": "Connect Uri",
"description": "Superset host URL.",
"default": "http://localhost:8088",
"type": "string"
},
"display_uri": {
"title": "Display Uri",
"description": "optional URL to use in links (if `connect_uri` is only for ingestion)",
"type": "string"
},
"username": {
"title": "Username",
"description": "Superset username.",
"type": "string"
},
"password": {
"title": "Password",
"description": "Superset password.",
"type": "string"
},
"provider": {
"title": "Provider",
"description": "Superset provider.",
"default": "db",
"type": "string"
},
"options": {
"title": "Options",
"default": {},
"type": "object"
},
"env": {
"title": "Env",
"description": "Environment to use in namespace when constructing URNs",
"default": "PROD",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "Can be used to change mapping for database names in superset to what you have in datahub",
"default": {},
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false
},
"unity-catalog": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"unity-catalog"
]
},
"config": {
"$ref": "#/definitions/unity-catalog_config"
}
},
"required": [
"type",
"config"
]
},
"unity-catalog_config": {
"title": "UnityCatalogSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"store_last_profiling_timestamps": {
"title": "Store Last Profiling Timestamps",
"description": "Enable storing last profile timestamp in store.",
"default": false,
"type": "boolean"
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"top_n_queries": {
"title": "Top N Queries",
"description": "Number of top queries to save to each table.",
"default": 10,
"exclusiveMinimum": 0,
"type": "integer"
},
"user_email_pattern": {
"title": "User Email Pattern",
"description": "regex patterns for user emails to filter in usage.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_operational_stats": {
"title": "Include Operational Stats",
"description": "Whether to display operational stats.",
"default": true,
"type": "boolean"
},
"include_read_operational_stats": {
"title": "Include Read Operational Stats",
"description": "Whether to report read operational stats. Experimental.",
"default": false,
"type": "boolean"
},
"format_sql_queries": {
"title": "Format Sql Queries",
"description": "Whether to format sql queries",
"default": false,
"type": "boolean"
},
"include_top_n_queries": {
"title": "Include Top N Queries",
"description": "Whether to ingest the top_n_queries.",
"default": true,
"type": "boolean"
},
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "Unity Catalog Stateful Ingestion Config.",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"token": {
"title": "Token",
"description": "Databricks personal access token",
"type": "string"
},
"workspace_url": {
"title": "Workspace Url",
"description": "Databricks workspace url. e.g. https://my-workspace.cloud.databricks.com",
"type": "string"
},
"workspace_name": {
"title": "Workspace Name",
"description": "Name of the workspace. Default to deployment name present in workspace_url",
"type": "string"
},
"catalog_pattern": {
"title": "Catalog Pattern",
"description": "Regex patterns for catalogs to filter in ingestion. Specify regex to match the full `metastore.catalog` name.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to the full `metastore.catalog.schema` name. e.g. to match all tables in schema analytics, use the regex `^mymetastore\\.mycatalog\\.analytics$`.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in `catalog.schema.table` format. e.g. to match all tables starting with customer in Customer catalog and public schema, use the regex `Customer\\.public\\.customer.*`.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to catalogs, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_table_lineage": {
"title": "Include Table Lineage",
"description": "Option to enable/disable lineage generation.",
"default": true,
"type": "boolean"
},
"include_ownership": {
"title": "Include Ownership",
"description": "Option to enable/disable ownership generation for metastores, catalogs, schemas, and tables.",
"default": false,
"type": "boolean"
},
"include_column_lineage": {
"title": "Include Column Lineage",
"description": "Option to enable/disable lineage generation. Currently we have to call a rest call per column to get column level lineage due to the Databrick api which can slow down ingestion. ",
"default": true,
"type": "boolean"
},
"include_usage_statistics": {
"title": "Include Usage Statistics",
"description": "Generate usage statistics.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"description": "Data profiling configuration",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"warehouse_id": null,
"profile_table_level_only": false,
"pattern": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"call_analyze": true,
"max_wait_secs": 3600,
"max_workers": 10
},
"allOf": [
{
"$ref": "#/definitions/UnityCatalogProfilerConfig"
}
]
}
},
"required": [
"token",
"workspace_url"
],
"additionalProperties": false
},
"feast": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"feast"
]
},
"config": {
"$ref": "#/definitions/feast_config"
}
},
"required": [
"type",
"config"
]
},
"feast_config": {
"title": "FeastRepositorySourceConfig",
"type": "object",
"properties": {
"path": {
"title": "Path",
"description": "Path to Feast repository",
"type": "string"
},
"fs_yaml_file": {
"title": "Fs Yaml File",
"description": "Path to the `feature_store.yaml` file used to configure the feature store",
"type": "string"
},
"environment": {
"title": "Environment",
"description": "Environment to use when constructing URNs",
"default": "PROD",
"type": "string"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"mode": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"mode"
]
},
"config": {
"$ref": "#/definitions/mode_config"
}
},
"required": [
"type",
"config"
]
},
"mode_config": {
"title": "ModeConfig",
"description": "Any non-Dataset source that produces lineage to Datasets should inherit this class.\ne.g. Orchestrators, Pipelines, BI Tools etc.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "A holder for platform -> platform_instance mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"connect_uri": {
"title": "Connect Uri",
"description": "Mode host URL.",
"default": "https://app.mode.com",
"type": "string"
},
"token": {
"title": "Token",
"description": "Mode user token.",
"type": "string"
},
"password": {
"title": "Password",
"description": "Mode password for authentication.",
"type": "string",
"writeOnly": true,
"format": "password"
},
"workspace": {
"title": "Workspace",
"type": "string"
},
"default_schema": {
"title": "Default Schema",
"description": "Default schema to use when schema is not provided in an SQL query",
"default": "public",
"type": "string"
},
"owner_username_instead_of_email": {
"title": "Owner Username Instead Of Email",
"description": "Use username for owner URN instead of Email",
"default": true,
"type": "boolean"
},
"api_options": {
"title": "Api Options",
"description": "Retry/Wait settings for Mode API to avoid \"Too many Requests\" error. See Mode API Options below",
"default": {
"retry_backoff_multiplier": 2,
"max_retry_interval": 10,
"max_attempts": 5
},
"allOf": [
{
"$ref": "#/definitions/ModeAPIConfig"
}
]
}
},
"required": [
"token",
"password"
],
"additionalProperties": false
},
"sqlalchemy": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"sqlalchemy"
]
},
"config": {
"$ref": "#/definitions/sqlalchemy_config"
}
},
"required": [
"type",
"config"
]
},
"sqlalchemy_config": {
"title": "SQLAlchemyGenericConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"platform": {
"title": "Platform",
"description": "Name of platform being ingested, used in constructing URNs.",
"type": "string"
},
"connect_uri": {
"title": "Connect Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls",
"type": "string"
}
},
"required": [
"platform",
"connect_uri"
],
"additionalProperties": false
},
"hana": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"hana"
]
},
"config": {
"$ref": "#/definitions/hana_config"
}
},
"required": [
"type",
"config"
]
},
"hana_config": {
"title": "HanaConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"default": "localhost:39041",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"default": "hana+hdbcli",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
}
},
"additionalProperties": false
},
"iceberg": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"iceberg"
]
},
"config": {
"$ref": "#/definitions/iceberg_config"
}
},
"required": [
"type",
"config"
]
},
"iceberg_config": {
"title": "IcebergSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "Iceberg Stateful Ingestion Config.",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"adls": {
"title": "Adls",
"description": "[Azure Data Lake Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction) to crawl for Iceberg tables. This is one filesystem type supported by this source and **only one can be configured**.",
"allOf": [
{
"$ref": "#/definitions/AdlsSourceConfig"
}
]
},
"localfs": {
"title": "Localfs",
"description": "Local path to crawl for Iceberg tables. This is one filesystem type supported by this source and **only one can be configured**.",
"type": "string"
},
"max_path_depth": {
"title": "Max Path Depth",
"description": "Maximum folder depth to crawl for Iceberg tables. Folders deeper than this value will be silently ignored.",
"default": 2,
"type": "integer"
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"user_ownership_property": {
"title": "User Ownership Property",
"description": "Iceberg table property to look for a `CorpUser` owner. Can only hold a single user value. If property has no value, no owner information will be emitted.",
"default": "owner",
"type": "string"
},
"group_ownership_property": {
"title": "Group Ownership Property",
"description": "Iceberg table property to look for a `CorpGroup` owner. Can only hold a single group value. If property has no value, no owner information will be emitted.",
"type": "string"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"include_field_null_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
}
},
"allOf": [
{
"$ref": "#/definitions/IcebergProfilingConfig"
}
]
}
},
"additionalProperties": false
},
"pulsar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"pulsar"
]
},
"config": {
"$ref": "#/definitions/pulsar_config"
}
},
"required": [
"type",
"config"
]
},
"pulsar_config": {
"title": "PulsarSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "see Stateful Ingestion",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"web_service_url": {
"title": "Web Service Url",
"description": "The web URL for the cluster.",
"default": "http://localhost:8080",
"type": "string"
},
"timeout": {
"title": "Timeout",
"description": "Timout setting, how long to wait for the Pulsar rest api to send data before giving up",
"default": 5,
"type": "integer"
},
"issuer_url": {
"title": "Issuer Url",
"description": "The complete URL for a Custom Authorization Server. Mandatory for OAuth based authentication.",
"type": "string"
},
"client_id": {
"title": "Client Id",
"description": "The application's client ID",
"type": "string"
},
"client_secret": {
"title": "Client Secret",
"description": "The application's client secret",
"type": "string"
},
"token": {
"title": "Token",
"description": "The access token for the application. Mandatory for token based authentication.",
"type": "string"
},
"verify_ssl": {
"title": "Verify Ssl",
"description": "Either a boolean, in which case it controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use.",
"default": true,
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"tenant_patterns": {
"title": "Tenant Patterns",
"description": "List of regex patterns for tenants to include/exclude from ingestion. By default all tenants are allowed.",
"default": {
"allow": [
".*"
],
"deny": [
"pulsar"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"namespace_patterns": {
"title": "Namespace Patterns",
"description": "List of regex patterns for namespaces to include/exclude from ingestion. By default the functions namespace is denied.",
"default": {
"allow": [
".*"
],
"deny": [
"public/functions"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"topic_patterns": {
"title": "Topic Patterns",
"description": "List of regex patterns for topics to include/exclude from ingestion. By default the Pulsar system topics are denied.",
"default": {
"allow": [
".*"
],
"deny": [
"/__.*$"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"exclude_individual_partitions": {
"title": "Exclude Individual Partitions",
"description": "Extract each individual partitioned topic. e.g. when turned off a topic with 100 partitions will result in 100 Datasets.",
"default": true,
"type": "boolean"
},
"tenants": {
"title": "Tenants",
"description": "Listing all tenants requires superUser role, alternative you can set a list of tenants you want to scrape using the tenant admin role",
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"domain": {
"title": "Domain",
"description": "Domain patterns",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"oid_config": {
"title": "Oid Config",
"description": "Placeholder for OpenId discovery document",
"type": "object"
}
},
"additionalProperties": false
},
"delta-lake": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"delta-lake"
]
},
"config": {
"$ref": "#/definitions/delta-lake_config"
}
},
"required": [
"type",
"config"
]
},
"delta-lake_config": {
"title": "DeltaLakeSourceConfig",
"description": "Any source that connects to a platform should inherit this class",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"base_path": {
"title": "Base Path",
"description": "Path to table (s3 or local file system). If path is not a delta table path then all subfolders will be scanned to detect and ingest delta tables.",
"type": "string"
},
"relative_path": {
"title": "Relative Path",
"description": "If set, delta-tables will be searched at location '<base_path>/<relative_path>' and URNs will be created using relative_path only.",
"type": "string"
},
"platform": {
"title": "Platform",
"description": "The platform that this source connects to",
"default": "delta-lake",
"const": "delta-lake",
"type": "string"
},
"table_pattern": {
"title": "Table Pattern",
"description": "regex patterns for tables to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"version_history_lookback": {
"title": "Version History Lookback",
"description": "Number of previous version histories to be ingested. Defaults to 1. If set to -1 all version history will be ingested.",
"default": 1,
"type": "integer"
},
"require_files": {
"title": "Require Files",
"description": "Whether DeltaTable should track files. Consider setting this to `False` for large delta tables, resulting in significant memory reduction for ingestion process.When set to `False`, number_of_files in delta table can not be reported.",
"default": true,
"type": "boolean"
},
"s3": {
"$ref": "#/definitions/S3"
}
},
"required": [
"base_path"
],
"additionalProperties": false
},
"azure-ad": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"azure-ad"
]
},
"config": {
"$ref": "#/definitions/azure-ad_config"
}
},
"required": [
"type",
"config"
]
},
"azure-ad_config": {
"title": "AzureADConfig",
"description": "Config to create a token and connect to Azure AD instance",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "Azure AD Stateful Ingestion Config.",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"client_id": {
"title": "Client Id",
"description": "Application ID. Found in your app registration on Azure AD Portal",
"type": "string"
},
"tenant_id": {
"title": "Tenant Id",
"description": "Directory ID. Found in your app registration on Azure AD Portal",
"type": "string"
},
"client_secret": {
"title": "Client Secret",
"description": "Client secret. Found in your app registration on Azure AD Portal",
"type": "string"
},
"authority": {
"title": "Authority",
"description": "The authority (https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-client-application-configuration) is a URL that indicates a directory that MSAL can request tokens from.",
"type": "string"
},
"token_url": {
"title": "Token Url",
"description": "The token URL that acquires a token from Azure AD for authorizing requests. This source will only work with v1.0 endpoint.",
"type": "string"
},
"redirect": {
"title": "Redirect",
"description": "Redirect URI. Found in your app registration on Azure AD Portal.",
"default": "https://login.microsoftonline.com/common/oauth2/nativeclient",
"type": "string"
},
"graph_url": {
"title": "Graph Url",
"description": "[Microsoft Graph API endpoint](https://docs.microsoft.com/en-us/graph/use-the-api)",
"default": "https://graph.microsoft.com/v1.0",
"type": "string"
},
"azure_ad_response_to_username_attr": {
"title": "Azure Ad Response To Username Attr",
"description": "Which Azure AD User Response attribute to use as input to DataHub username mapping.",
"default": "userPrincipalName",
"type": "string"
},
"azure_ad_response_to_username_regex": {
"title": "Azure Ad Response To Username Regex",
"description": "A regex used to parse the DataHub username from the attribute specified in `azure_ad_response_to_username_attr`.",
"default": "(.*)",
"type": "string"
},
"azure_ad_response_to_groupname_attr": {
"title": "Azure Ad Response To Groupname Attr",
"description": "Which Azure AD Group Response attribute to use as input to DataHub group name mapping.",
"default": "displayName",
"type": "string"
},
"azure_ad_response_to_groupname_regex": {
"title": "Azure Ad Response To Groupname Regex",
"description": "A regex used to parse the DataHub group name from the attribute specified in `azure_ad_response_to_groupname_attr`.",
"default": "(.*)",
"type": "string"
},
"ingest_users": {
"title": "Ingest Users",
"description": "Whether users should be ingested into DataHub.",
"default": true,
"type": "boolean"
},
"ingest_groups": {
"title": "Ingest Groups",
"description": "Whether groups should be ingested into DataHub.",
"default": true,
"type": "boolean"
},
"ingest_group_membership": {
"title": "Ingest Group Membership",
"description": "Whether group membership should be ingested into DataHub. ingest_groups must be True if this is True.",
"default": true,
"type": "boolean"
},
"ingest_groups_users": {
"title": "Ingest Groups Users",
"description": "This option is useful only when `ingest_users` is set to False and `ingest_group_membership` to True. As effect, only the users which belongs to the selected groups will be ingested.",
"default": true,
"type": "boolean"
},
"users_pattern": {
"title": "Users Pattern",
"description": "regex patterns for users to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"groups_pattern": {
"title": "Groups Pattern",
"description": "regex patterns for groups to include in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"filtered_tracking": {
"title": "Filtered Tracking",
"description": "If enabled, report will contain names of filtered users and groups.",
"default": true,
"type": "boolean"
},
"mask_group_id": {
"title": "Mask Group Id",
"description": "Whether workunit ID's for groups should be masked to avoid leaking sensitive information.",
"default": true,
"type": "boolean"
},
"mask_user_id": {
"title": "Mask User Id",
"description": "Whether workunit ID's for users should be masked to avoid leaking sensitive information.",
"default": true,
"type": "boolean"
}
},
"required": [
"client_id",
"tenant_id",
"client_secret",
"authority",
"token_url"
],
"additionalProperties": false
},
"openapi": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"openapi"
]
},
"config": {
"$ref": "#/definitions/openapi_config"
}
},
"required": [
"type",
"config"
]
},
"openapi_config": {
"title": "OpenApiConfig",
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"url": {
"title": "Url",
"type": "string"
},
"swagger_file": {
"title": "Swagger File",
"type": "string"
},
"ignore_endpoints": {
"title": "Ignore Endpoints",
"default": [],
"type": "array",
"items": {}
},
"username": {
"title": "Username",
"default": "",
"type": "string"
},
"password": {
"title": "Password",
"default": "",
"type": "string"
},
"forced_examples": {
"title": "Forced Examples",
"default": {},
"type": "object"
},
"token": {
"title": "Token",
"type": "string"
},
"get_token": {
"title": "Get Token",
"default": {},
"type": "object"
}
},
"required": [
"name",
"url",
"swagger_file"
],
"additionalProperties": false
},
"kafka": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kafka"
]
},
"config": {
"$ref": "#/definitions/kafka_config"
}
},
"required": [
"type",
"config"
]
},
"kafka_config": {
"title": "KafkaSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"connection": {
"title": "Connection",
"default": {
"bootstrap": "localhost:9092",
"schema_registry_url": "http://localhost:8080/schema-registry/api/",
"schema_registry_config": {},
"client_timeout_seconds": 60,
"consumer_config": {}
},
"allOf": [
{
"$ref": "#/definitions/KafkaConsumerConnectionConfig"
}
]
},
"topic_patterns": {
"title": "Topic Patterns",
"default": {
"allow": [
".*"
],
"deny": [
"^_.*"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "A map of domain names to allow deny patterns. Domains can be urn-based (`urn:li:domain:13ae4d85-d955-49fc-8474-9004c663a810`) or bare (`13ae4d85-d955-49fc-8474-9004c663a810`).",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"topic_subject_map": {
"title": "Topic Subject Map",
"description": "Provides the mapping for the `key` and the `value` schemas of a topic to the corresponding schema registry subject name. Each entry of this map has the form `<topic_name>-key`:`<schema_registry_subject_name_for_key_schema>` and `<topic_name>-value`:`<schema_registry_subject_name_for_value_schema>` for the key and the value schemas associated with the topic, respectively. This parameter is mandatory when the [RecordNameStrategy](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#how-the-naming-strategies-work) is used as the subject naming strategy in the kafka schema registry. NOTE: When provided, this overrides the default subject name resolution even when the `TopicNameStrategy` or the `TopicRecordNameStrategy` are used.",
"default": {},
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"schema_registry_class": {
"title": "Schema Registry Class",
"description": "The fully qualified implementation class(custom) that implements the KafkaSchemaRegistryBase interface.",
"default": "datahub.ingestion.source.confluent_schema_registry.ConfluentSchemaRegistry",
"type": "string"
},
"ignore_warnings_on_schema_type": {
"title": "Ignore Warnings On Schema Type",
"description": "Disables warnings reported for non-AVRO/Protobuf value or key schemas if set.",
"default": false,
"type": "boolean"
},
"disable_topic_record_naming_strategy": {
"title": "Disable Topic Record Naming Strategy",
"description": "Disables the utilization of the TopicRecordNameStrategy for Schema Registry subjects. For more information, visit: https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#handling-differences-between-preregistered-and-client-derived-schemas:~:text=io.confluent.kafka.serializers.subject.TopicRecordNameStrategy",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"datahub-lineage-file": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"datahub-lineage-file"
]
},
"config": {
"$ref": "#/definitions/datahub-lineage-file_config"
}
},
"required": [
"type",
"config"
]
},
"datahub-lineage-file_config": {
"title": "LineageFileSourceConfig",
"type": "object",
"properties": {
"file": {
"title": "File",
"description": "File path or URL to lineage file to ingest.",
"type": "string"
},
"preserve_upstream": {
"title": "Preserve Upstream",
"description": "Whether we want to query datahub-gms for upstream data. False means it will hard replace upstream data for a given entity. True means it will query the backend for existing upstreams and include it in the ingestion run",
"default": true,
"type": "boolean"
}
},
"required": [
"file"
],
"additionalProperties": false
},
"postgres": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"postgres"
]
},
"config": {
"$ref": "#/definitions/postgres_config"
}
},
"required": [
"type",
"config"
]
},
"postgres_config": {
"title": "PostgresConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"default": {
"allow": [
".*"
],
"deny": [
"information_schema"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog). If set to Null, all databases will be considered for ingestion.",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"description": "database scheme",
"default": "postgresql+psycopg2",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "Regex patterns for databases to filter in ingestion. Note: this is not used if `database` or `sqlalchemy_uri` are provided.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"initial_database": {
"title": "Initial Database",
"description": "Initial database used to query for the list of databases, when ingesting multiple databases. Note: this is not used if `database` or `sqlalchemy_uri` are provided.",
"default": "postgres",
"type": "string"
},
"include_view_lineage": {
"title": "Include View Lineage",
"description": "Include table lineage for views",
"default": false,
"type": "boolean"
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"gcs": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"gcs"
]
},
"config": {
"$ref": "#/definitions/gcs_config"
}
},
"required": [
"type",
"config"
]
},
"gcs_config": {
"title": "GCSSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"path_specs": {
"title": "Path Specs",
"description": "List of PathSpec. See [below](#path-spec) the details about PathSpec",
"type": "array",
"items": {
"$ref": "#/definitions/PathSpec"
}
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"credential": {
"title": "Credential",
"description": "Google cloud storage [HMAC keys](https://cloud.google.com/storage/docs/authentication/hmackeys)",
"allOf": [
{
"$ref": "#/definitions/HMACKey"
}
]
},
"max_rows": {
"title": "Max Rows",
"description": "Maximum number of rows to use when inferring schemas for TSV and CSV files.",
"default": 100,
"type": "integer"
},
"number_of_files_to_sample": {
"title": "Number Of Files To Sample",
"description": "Number of files to list to sample for schema inference. This will be ignored if sample_files is set to False in the pathspec.",
"default": 100,
"type": "integer"
}
},
"required": [
"path_specs",
"credential"
],
"additionalProperties": false
},
"csv-enricher": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv-enricher"
]
},
"config": {
"$ref": "#/definitions/csv-enricher_config"
}
},
"required": [
"type",
"config"
]
},
"csv-enricher_config": {
"title": "CSVEnricherConfig",
"type": "object",
"properties": {
"filename": {
"title": "Filename",
"description": "File path or URL of CSV file to ingest.",
"type": "string"
},
"write_semantics": {
"title": "Write Semantics",
"description": "Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be \"PATCH\" or \"OVERRIDE\"",
"default": "PATCH",
"type": "string"
},
"delimiter": {
"title": "Delimiter",
"description": "Delimiter to use when parsing CSV",
"default": ",",
"type": "string"
},
"array_delimiter": {
"title": "Array Delimiter",
"description": "Delimiter to use when parsing array fields (tags, terms and owners)",
"default": "|",
"type": "string"
}
},
"required": [
"filename"
],
"additionalProperties": false
},
"metabase": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"metabase"
]
},
"config": {
"$ref": "#/definitions/metabase_config"
}
},
"required": [
"type",
"config"
]
},
"metabase_config": {
"title": "MetabaseConfig",
"description": "Any non-Dataset source that produces lineage to Datasets should inherit this class.\ne.g. Orchestrators, Pipelines, BI Tools etc.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "A holder for platform -> platform_instance mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"connect_uri": {
"title": "Connect Uri",
"description": "Metabase host URL.",
"default": "localhost:3000",
"type": "string"
},
"username": {
"title": "Username",
"description": "Metabase username.",
"type": "string"
},
"password": {
"title": "Password",
"description": "Metabase password.",
"type": "string",
"writeOnly": true,
"format": "password"
},
"database_alias_map": {
"title": "Database Alias Map",
"description": "Database name map to use when constructing dataset URN.",
"type": "object"
},
"engine_platform_map": {
"title": "Engine Platform Map",
"description": "Custom mappings between metabase database engines and DataHub platforms",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"database_id_to_instance_map": {
"title": "Database Id To Instance Map",
"description": "Custom mappings between metabase database id and DataHub platform instance",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"default_schema": {
"title": "Default Schema",
"description": "Default schema name to use when schema is not provided in an SQL query",
"default": "public",
"type": "string"
}
},
"additionalProperties": false
},
"athena": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"athena"
]
},
"config": {
"$ref": "#/definitions/athena_config"
}
},
"required": [
"type",
"config"
]
},
"athena_config": {
"title": "AthenaConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": false,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"scheme": {
"title": "Scheme",
"default": "awsathena+rest",
"type": "string"
},
"username": {
"title": "Username",
"description": "Username credential. If not specified, detected with boto3 rules. See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html",
"type": "string"
},
"password": {
"title": "Password",
"description": "Same detection scheme as username",
"type": "string",
"writeOnly": true,
"format": "password"
},
"database": {
"title": "Database",
"description": "The athena database to ingest from. If not set it will be autodetected",
"type": "string"
},
"aws_region": {
"title": "Aws Region",
"description": "Aws region where your Athena database is located",
"type": "string"
},
"aws_role_arn": {
"title": "Aws Role Arn",
"description": "AWS Role arn for Pyathena to assume in its connection",
"type": "string"
},
"aws_role_assumption_duration": {
"title": "Aws Role Assumption Duration",
"description": "Duration to assume the AWS Role for. Maximum of 43200 (12 hours)",
"default": 3600,
"type": "integer"
},
"s3_staging_dir": {
"title": "S3 Staging Dir",
"description": "[deprecated in favor of `query_result_location`] S3 query location",
"deprecated": true,
"type": "string"
},
"work_group": {
"title": "Work Group",
"description": "The name of your Amazon Athena Workgroups",
"type": "string"
},
"catalog_name": {
"title": "Catalog Name",
"description": "Athena Catalog Name",
"default": "awsdatacatalog",
"type": "string"
},
"query_result_location": {
"title": "Query Result Location",
"description": "S3 path to the [query result bucket](https://docs.aws.amazon.com/athena/latest/ug/querying.html#query-results-specify-location) which should be used by AWS Athena to store results of thequeries executed by DataHub.",
"type": "string"
}
},
"required": [
"aws_region",
"work_group",
"query_result_location"
],
"additionalProperties": false
},
"trino": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"trino"
]
},
"config": {
"$ref": "#/definitions/trino_config"
}
},
"required": [
"type",
"config"
]
},
"trino_config": {
"title": "TrinoConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"tableau": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"tableau"
]
},
"config": {
"$ref": "#/definitions/tableau_config"
}
},
"required": [
"type",
"config"
]
},
"tableau_config": {
"title": "TableauConfig",
"description": "Any non-Dataset source that produces lineage to Datasets should inherit this class.\ne.g. Orchestrators, Pipelines, BI Tools etc.",
"type": "object",
"properties": {
"connect_uri": {
"title": "Connect Uri",
"description": "Tableau host URL.",
"type": "string"
},
"username": {
"title": "Username",
"description": "Tableau username, must be set if authenticating using username/password.",
"type": "string"
},
"password": {
"title": "Password",
"description": "Tableau password, must be set if authenticating using username/password.",
"type": "string"
},
"token_name": {
"title": "Token Name",
"description": "Tableau token name, must be set if authenticating using a personal access token.",
"type": "string"
},
"token_value": {
"title": "Token Value",
"description": "Tableau token value, must be set if authenticating using a personal access token.",
"type": "string"
},
"site": {
"title": "Site",
"description": "Tableau Site. Always required for Tableau Online. Use emptystring to connect with Default site on Tableau Server.",
"default": "",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"ssl_verify": {
"title": "Ssl Verify",
"description": "Whether to verify SSL certificates. If using self-signed certificates, set to false or provide the path to the .pem certificate bundle.",
"default": true,
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"extract_column_level_lineage": {
"title": "Extract Column Level Lineage",
"description": "When enabled, extracts column-level lineage from Tableau Datasources",
"default": true,
"type": "boolean"
},
"env": {
"title": "Env",
"description": "Environment to use in namespace when constructing URNs.",
"default": "PROD",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "A holder for platform -> platform_instance mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"projects": {
"title": "Projects",
"description": "[deprecated] Use project_pattern instead. List of tableau projects ",
"default": [
"default"
],
"type": "array",
"items": {
"type": "string"
}
},
"project_pattern": {
"title": "Project Pattern",
"description": "Filter for specific Tableau projects. For example, use 'My Project' to ingest a root-level Project with name 'My Project', or 'My Project/Nested Project' to ingest a nested Project with name 'Nested Project'. By default, all Projects nested inside a matching Project will be included in ingestion. You can both allow and deny projects based on their name using their name, or a Regex pattern. Deny patterns always take precedence over allow patterns. By default, all projects will be ingested.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"project_path_separator": {
"title": "Project Path Separator",
"description": "The separator used for the project_pattern field between project names. By default, we use a slash. You can change this if your Tableau projects contain slashes in their names, and you'd like to filter by project.",
"default": "/",
"type": "string"
},
"default_schema_map": {
"title": "Default Schema Map",
"description": "Default schema to use when schema is not found.",
"default": {},
"type": "object"
},
"ingest_tags": {
"title": "Ingest Tags",
"description": "Ingest Tags from source. This will override Tags entered from UI",
"default": false,
"type": "boolean"
},
"ingest_owner": {
"title": "Ingest Owner",
"description": "Ingest Owner from source. This will override Owner info entered from UI",
"default": false,
"type": "boolean"
},
"ingest_tables_external": {
"title": "Ingest Tables External",
"description": "Ingest details for tables external to (not embedded in) tableau as entities.",
"default": false,
"type": "boolean"
},
"page_size": {
"title": "Page Size",
"description": "[advanced] Number of metadata objects (e.g. CustomSQLTable, PublishedDatasource, etc) to query at a time using the Tableau API.",
"default": 10,
"type": "integer"
},
"workbook_page_size": {
"title": "Workbook Page Size",
"description": "[advanced] Number of workbooks to query at a time using the Tableau API.",
"default": 1,
"type": "integer"
},
"lineage_overrides": {
"title": "Lineage Overrides",
"description": "Mappings to change generated dataset urns. Use only if you really know what you are doing.",
"allOf": [
{
"$ref": "#/definitions/TableauLineageOverrides"
}
]
},
"extract_usage_stats": {
"title": "Extract Usage Stats",
"description": "[experimental] Extract usage statistics for dashboards and charts.",
"default": false,
"type": "boolean"
},
"ingest_embed_url": {
"title": "Ingest Embed Url",
"description": "Ingest a URL to render an embedded Preview of assets within Tableau.",
"default": false,
"type": "boolean"
},
"ingest_external_links_for_dashboards": {
"title": "Ingest External Links For Dashboards",
"description": "Ingest a URL to link out to from dashboards.",
"default": true,
"type": "boolean"
},
"ingest_external_links_for_charts": {
"title": "Ingest External Links For Charts",
"description": "Ingest a URL to link out to from charts.",
"default": true,
"type": "boolean"
},
"extract_project_hierarchy": {
"title": "Extract Project Hierarchy",
"description": "Whether to extract entire project hierarchy for nested projects.",
"default": true,
"type": "boolean"
},
"extract_lineage_from_unsupported_custom_sql_queries": {
"title": "Extract Lineage From Unsupported Custom Sql Queries",
"description": "[Experimental] Whether to extract lineage from unsupported custom sql queries using SQL parsing",
"default": false,
"type": "boolean"
}
},
"required": [
"connect_uri"
],
"additionalProperties": false
},
"mssql": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"mssql"
]
},
"config": {
"$ref": "#/definitions/mssql_config"
}
},
"required": [
"type",
"config"
]
},
"mssql_config": {
"title": "SQLServerConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "MSSQL host URL.",
"default": "localhost:1433",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog). If set to Null, all databases will be considered for ingestion.",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"use_odbc": {
"title": "Use Odbc",
"description": "See https://docs.sqlalchemy.org/en/14/dialects/mssql.html#module-sqlalchemy.dialects.mssql.pyodbc.",
"default": false,
"type": "boolean"
},
"uri_args": {
"title": "Uri Args",
"description": "Arguments to URL-encode when connecting. See https://docs.microsoft.com/en-us/sql/connect/odbc/dsn-connection-string-attribute?view=sql-server-ver15.",
"default": {},
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"database_pattern": {
"title": "Database Pattern",
"description": "Regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"convert_urns_to_lowercase": {
"title": "Convert Urns To Lowercase",
"description": "Enable to convert the SQL Server assets urns to lowercase",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"nifi": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"nifi"
]
},
"config": {
"$ref": "#/definitions/nifi_config"
}
},
"required": [
"type",
"config"
]
},
"nifi_config": {
"title": "NifiSourceConfig",
"description": "Any source that produces dataset urns in a single environment should inherit this class",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"site_url": {
"title": "Site Url",
"description": "URL for Nifi, ending with /nifi/. e.g. https://mynifi.domain/nifi/",
"type": "string"
},
"auth": {
"description": "Nifi authentication. must be one of : NO_AUTH, SINGLE_USER, CLIENT_CERT, KERBEROS",
"default": "NO_AUTH",
"allOf": [
{
"$ref": "#/definitions/NifiAuthType"
}
]
},
"provenance_days": {
"title": "Provenance Days",
"description": "time window to analyze provenance events for external datasets",
"default": 7,
"type": "integer"
},
"process_group_pattern": {
"title": "Process Group Pattern",
"description": "regex patterns for filtering process groups",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"site_name": {
"title": "Site Name",
"description": "Site name to identify this site with, useful when using input and output ports receiving remote connections",
"default": "default",
"type": "string"
},
"site_url_to_site_name": {
"title": "Site Url To Site Name",
"description": "Lookup to find site_name for site_url ending with /nifi/, required if using remote process groups in nifi flow",
"default": {},
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"username": {
"title": "Username",
"description": "Nifi username, must be set for auth = \"SINGLE_USER\"",
"type": "string"
},
"password": {
"title": "Password",
"description": "Nifi password, must be set for auth = \"SINGLE_USER\"",
"type": "string"
},
"client_cert_file": {
"title": "Client Cert File",
"description": "Path to PEM file containing the public certificates for the user/client identity, must be set for auth = \"CLIENT_CERT\"",
"type": "string"
},
"client_key_file": {
"title": "Client Key File",
"description": "Path to PEM file containing the client\u2019s secret key",
"type": "string"
},
"client_key_password": {
"title": "Client Key Password",
"description": "The password to decrypt the client_key_file",
"type": "string"
},
"ca_file": {
"title": "Ca File",
"description": "Path to PEM file containing certs for the root CA(s) for the NiFi",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
}
},
"required": [
"site_url"
],
"additionalProperties": false
},
"ldap": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ldap"
]
},
"config": {
"$ref": "#/definitions/ldap_config"
}
},
"required": [
"type",
"config"
]
},
"ldap_config": {
"title": "LDAPSourceConfig",
"description": "Config used by the LDAP Source.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"ldap_server": {
"title": "Ldap Server",
"description": "LDAP server URL.",
"type": "string"
},
"ldap_user": {
"title": "Ldap User",
"description": "LDAP user.",
"type": "string"
},
"ldap_password": {
"title": "Ldap Password",
"description": "LDAP password.",
"type": "string"
},
"base_dn": {
"title": "Base Dn",
"description": "LDAP DN.",
"type": "string"
},
"filter": {
"title": "Filter",
"description": "LDAP extractor filter.",
"default": "(objectClass=*)",
"type": "string"
},
"attrs_list": {
"title": "Attrs List",
"description": "Retrieved attributes list",
"type": "array",
"items": {
"type": "string"
}
},
"custom_props_list": {
"title": "Custom Props List",
"description": "A list of custom attributes to extract from the LDAP provider.",
"type": "array",
"items": {
"type": "string"
}
},
"drop_missing_first_last_name": {
"title": "Drop Missing First Last Name",
"description": "If set to true, any users without first and last names will be dropped.",
"default": true,
"type": "boolean"
},
"page_size": {
"title": "Page Size",
"description": "Size of each page to fetch when extracting metadata.",
"default": 20,
"type": "integer"
},
"manager_filter_enabled": {
"title": "Manager Filter Enabled",
"description": "Use LDAP extractor filter to search managers.",
"default": true,
"type": "boolean"
},
"manager_pagination_enabled": {
"title": "Manager Pagination Enabled",
"description": "[deprecated] Use pagination_enabled ",
"default": true,
"type": "boolean"
},
"pagination_enabled": {
"title": "Pagination Enabled",
"description": "Use pagination while do search query (enabled by default).",
"default": true,
"type": "boolean"
},
"user_attrs_map": {
"title": "User Attrs Map",
"default": {},
"type": "object"
},
"group_attrs_map": {
"title": "Group Attrs Map",
"default": {},
"type": "object"
}
},
"required": [
"ldap_server",
"ldap_user",
"ldap_password",
"base_dn"
],
"additionalProperties": false
},
"dbt-cloud": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"dbt-cloud"
]
},
"config": {
"$ref": "#/definitions/dbt-cloud_config"
}
},
"required": [
"type",
"config"
]
},
"dbt-cloud_config": {
"title": "DBTCloudConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"incremental_lineage": {
"title": "Incremental Lineage",
"description": "When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.",
"default": true,
"type": "boolean"
},
"sql_parser_use_external_process": {
"title": "Sql Parser Use External Process",
"description": "When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.",
"default": false,
"type": "boolean"
},
"env": {
"title": "Env",
"description": "Environment to use in namespace when constructing URNs.",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"title": "Stateful Ingestion",
"description": "DBT Stateful Ingestion Config.",
"allOf": [
{
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
}
]
},
"target_platform": {
"title": "Target Platform",
"description": "The platform that dbt is loading onto. (e.g. bigquery / redshift / postgres etc.)",
"type": "string"
},
"target_platform_instance": {
"title": "Target Platform Instance",
"description": "The platform instance for the platform that dbt is operating on. Use this if you have multiple instances of the same platform (e.g. redshift) and need to distinguish between them.",
"type": "string"
},
"use_identifiers": {
"title": "Use Identifiers",
"description": "Use model identifier instead of model name if defined (if not, default to model name).",
"default": false,
"type": "boolean"
},
"entities_enabled": {
"title": "Entities Enabled",
"description": "Controls for enabling / disabling metadata emission for different dbt entities (models, test definitions, test results, etc.)",
"default": {
"models": "YES",
"sources": "YES",
"seeds": "YES",
"snapshots": "YES",
"test_definitions": "YES",
"test_results": "YES"
},
"allOf": [
{
"$ref": "#/definitions/DBTEntitiesEnabled"
}
]
},
"tag_prefix": {
"title": "Tag Prefix",
"description": "Prefix added to tags during ingestion.",
"default": "dbt:",
"type": "string"
},
"node_name_pattern": {
"title": "Node Name Pattern",
"description": "regex patterns for dbt model names to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"meta_mapping": {
"title": "Meta Mapping",
"description": "mapping rules that will be executed against dbt meta properties. Refer to the section below on dbt meta automated mappings.",
"default": {},
"type": "object"
},
"column_meta_mapping": {
"title": "Column Meta Mapping",
"description": "mapping rules that will be executed against dbt column meta properties. Refer to the section below on dbt meta automated mappings.",
"default": {},
"type": "object"
},
"query_tag_mapping": {
"title": "Query Tag Mapping",
"description": "mapping rules that will be executed against dbt query_tag meta properties. Refer to the section below on dbt meta automated mappings.",
"default": {},
"type": "object"
},
"write_semantics": {
"title": "Write Semantics",
"description": "Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be \"PATCH\" or \"OVERRIDE\"",
"default": "PATCH",
"type": "string"
},
"strip_user_ids_from_email": {
"title": "Strip User Ids From Email",
"description": "Whether or not to strip email id while adding owners using dbt meta actions.",
"default": false,
"type": "boolean"
},
"enable_owner_extraction": {
"title": "Enable Owner Extraction",
"description": "When enabled, ownership info will be extracted from the dbt meta",
"default": true,
"type": "boolean"
},
"owner_extraction_pattern": {
"title": "Owner Extraction Pattern",
"description": "Regex string to extract owner from the dbt node using the `(?P<name>...) syntax` of the [match object](https://docs.python.org/3/library/re.html#match-objects), where the group name must be `owner`. Examples: (1)`r\"(?P<owner>(.*)): (\\w+) (\\w+)\"` will extract `jdoe` as the owner from `\"jdoe: John Doe\"` (2) `r\"@(?P<owner>(.*))\"` will extract `alice` as the owner from `\"@alice\"`.",
"type": "string"
},
"include_env_in_assertion_guid": {
"title": "Include Env In Assertion Guid",
"description": "Prior to version 0.9.4.2, the assertion GUIDs did not include the environment. If you're using multiple dbt ingestion that are only distinguished by env, then you should set this flag to True.",
"default": false,
"type": "boolean"
},
"convert_column_urns_to_lowercase": {
"title": "Convert Column Urns To Lowercase",
"description": "When enabled, converts column URNs to lowercase to ensure cross-platform compatibility. If `target_platform` is Snowflake, the default is True.",
"default": false,
"type": "boolean"
},
"enable_meta_mapping": {
"title": "Enable Meta Mapping",
"description": "When enabled, applies the mappings that are defined through the meta_mapping directives.",
"default": true,
"type": "boolean"
},
"enable_query_tag_mapping": {
"title": "Enable Query Tag Mapping",
"description": "When enabled, applies the mappings that are defined through the `query_tag_mapping` directives.",
"default": true,
"type": "boolean"
},
"metadata_endpoint": {
"title": "Metadata Endpoint",
"description": "The dbt Cloud metadata API endpoint.",
"default": "https://metadata.cloud.getdbt.com/graphql",
"type": "string"
},
"token": {
"title": "Token",
"description": "The API token to use to authenticate with DBT Cloud.",
"type": "string"
},
"account_id": {
"title": "Account Id",
"description": "The DBT Cloud account ID to use.",
"type": "integer"
},
"project_id": {
"title": "Project Id",
"description": "The dbt Cloud project ID to use.",
"type": "integer"
},
"job_id": {
"title": "Job Id",
"description": "The ID of the job to ingest metadata from.",
"type": "integer"
},
"run_id": {
"title": "Run Id",
"description": "The ID of the run to ingest metadata from. If not specified, we'll default to the latest run.",
"type": "integer"
}
},
"required": [
"target_platform",
"token",
"account_id",
"project_id",
"job_id"
],
"additionalProperties": false
},
"file": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"file"
]
},
"config": {
"$ref": "#/definitions/file_config"
}
},
"required": [
"type",
"config"
]
},
"file_config": {
"title": "FileSourceConfig",
"type": "object",
"properties": {
"path": {
"title": "Path",
"description": "File path to folder or file to ingest, or URL to a remote file. If pointed to a folder, all files with extension {file_extension} (default json) within that folder will be processed.",
"type": "string"
},
"file_extension": {
"title": "File Extension",
"description": "When providing a folder to use to read files, set this field to control file extensions that you want the source to process. * is a special value that means process every file regardless of extension",
"default": ".json",
"type": "string"
},
"read_mode": {
"default": "AUTO",
"allOf": [
{
"$ref": "#/definitions/FileReadMode"
}
]
},
"aspect": {
"title": "Aspect",
"description": "Set to an aspect to only read this aspect for ingestion.",
"type": "string"
},
"count_all_before_starting": {
"title": "Count All Before Starting",
"description": "When enabled, counts total number of records in the file before starting. Used for accurate estimation of completion time. Turn it off if startup time is too high.",
"default": true,
"type": "boolean"
}
},
"required": [
"path"
],
"additionalProperties": false
},
"s3": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"s3"
]
},
"config": {
"$ref": "#/definitions/s3_config"
}
},
"required": [
"type",
"config"
]
},
"s3_config": {
"title": "DataLakeSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"path_specs": {
"title": "Path Specs",
"description": "List of PathSpec. See [below](#path-spec) the details about PathSpec",
"type": "array",
"items": {
"$ref": "#/definitions/PathSpec"
}
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"platform": {
"title": "Platform",
"description": "The platform that this source connects to (either 's3' or 'file'). If not specified, the platform will be inferred from the path_specs.",
"default": "",
"type": "string"
},
"aws_config": {
"title": "Aws Config",
"description": "AWS configuration",
"allOf": [
{
"$ref": "#/definitions/AwsConnectionConfig"
}
]
},
"use_s3_bucket_tags": {
"title": "Use S3 Bucket Tags",
"description": "Whether or not to create tags in datahub from the s3 bucket",
"type": "boolean"
},
"use_s3_object_tags": {
"title": "Use S3 Object Tags",
"description": "Whether or not to create tags in datahub from the s3 object",
"type": "boolean"
},
"profile_patterns": {
"title": "Profile Patterns",
"description": "regex patterns for tables to profile ",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profiling": {
"title": "Profiling",
"description": "Data profiling configuration",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"profile_table_level_only": false,
"max_number_of_fields_to_profile": null,
"include_field_null_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": true,
"include_field_distinct_value_frequencies": true,
"include_field_histogram": true,
"include_field_sample_values": true
},
"allOf": [
{
"$ref": "#/definitions/DataLakeProfilerConfig"
}
]
},
"spark_driver_memory": {
"title": "Spark Driver Memory",
"description": "Max amount of memory to grant Spark.",
"default": "4g",
"type": "string"
},
"spark_config": {
"title": "Spark Config",
"description": "Spark configuration properties to set on the SparkSession. Put config property names into quotes. For example: '\"spark.executor.memory\": \"2g\"'",
"default": {},
"type": "object"
},
"max_rows": {
"title": "Max Rows",
"description": "Maximum number of rows to use when inferring schemas for TSV and CSV files.",
"default": 100,
"type": "integer"
},
"verify_ssl": {
"title": "Verify Ssl",
"description": "Either a boolean, in which case it controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use.",
"default": true,
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"number_of_files_to_sample": {
"title": "Number Of Files To Sample",
"description": "Number of files to list to sample for schema inference. This will be ignored if sample_files is set to False in the pathspec.",
"default": 100,
"type": "integer"
}
},
"required": [
"path_specs"
],
"additionalProperties": false
},
"looker": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"looker"
]
},
"config": {
"$ref": "#/definitions/looker_config"
}
},
"required": [
"type",
"config"
]
},
"looker_config": {
"title": "LookerDashboardSourceConfig",
"description": "Any source that is a primary producer of Dataset metadata should inherit this class",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"explore_naming_pattern": {
"title": "Explore Naming Pattern",
"description": "Pattern for providing dataset names to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']",
"default": {
"pattern": "{model}.explore.{name}"
},
"allOf": [
{
"$ref": "#/definitions/LookerNamingPattern"
}
]
},
"explore_browse_pattern": {
"title": "Explore Browse Pattern",
"description": "Pattern for providing browse paths to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']",
"default": {
"pattern": "/{env}/{platform}/{project}/explores"
},
"allOf": [
{
"$ref": "#/definitions/LookerNamingPattern"
}
]
},
"view_naming_pattern": {
"title": "View Naming Pattern",
"description": "Pattern for providing dataset names to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']",
"default": {
"pattern": "{project}.view.{name}"
},
"allOf": [
{
"$ref": "#/definitions/LookerNamingPattern"
}
]
},
"view_browse_pattern": {
"title": "View Browse Pattern",
"description": "Pattern for providing browse paths to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']",
"default": {
"pattern": "/{env}/{platform}/{project}/views"
},
"allOf": [
{
"$ref": "#/definitions/LookerNamingPattern"
}
]
},
"tag_measures_and_dimensions": {
"title": "Tag Measures And Dimensions",
"description": "When enabled, attaches tags to measures, dimensions and dimension groups to make them more discoverable. When disabled, adds this information to the description of the column.",
"default": true,
"type": "boolean"
},
"platform_name": {
"title": "Platform Name",
"description": "Default platform name. Don't change.",
"default": "looker",
"type": "string"
},
"extract_column_level_lineage": {
"title": "Extract Column Level Lineage",
"description": "When enabled, extracts column-level lineage from Views and Explores",
"default": true,
"type": "boolean"
},
"client_id": {
"title": "Client Id",
"description": "Looker API client id.",
"type": "string"
},
"client_secret": {
"title": "Client Secret",
"description": "Looker API client secret.",
"type": "string"
},
"base_url": {
"title": "Base Url",
"description": "Url to your Looker instance: `https://company.looker.com:19999` or `https://looker.company.com`, or similar. Used for making API calls to Looker and constructing clickable dashboard and chart urls.",
"type": "string"
},
"transport_options": {
"title": "Transport Options",
"description": "Populates the [TransportOptions](https://github.com/looker-open-source/sdk-codegen/blob/94d6047a0d52912ac082eb91616c1e7c379ab262/python/looker_sdk/rtl/transport.py#L70) struct for looker client",
"allOf": [
{
"$ref": "#/definitions/TransportOptionsConfig"
}
]
},
"dashboard_pattern": {
"title": "Dashboard Pattern",
"description": "Patterns for selecting dashboard ids that are to be included",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"chart_pattern": {
"title": "Chart Pattern",
"description": "Patterns for selecting chart ids that are to be included",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_deleted": {
"title": "Include Deleted",
"description": "Whether to include deleted dashboards and looks.",
"default": false,
"type": "boolean"
},
"extract_owners": {
"title": "Extract Owners",
"description": "When enabled, extracts ownership from Looker directly. When disabled, ownership is left empty for dashboards and charts.",
"default": true,
"type": "boolean"
},
"actor": {
"title": "Actor",
"description": "This config is deprecated in favor of `extract_owners`. Previously, was the actor to use in ownership properties of ingested metadata.",
"type": "string"
},
"strip_user_ids_from_email": {
"title": "Strip User Ids From Email",
"description": "When enabled, converts Looker user emails of the form [email protected] to urn:li:corpuser:name when assigning ownership",
"default": false,
"type": "boolean"
},
"skip_personal_folders": {
"title": "Skip Personal Folders",
"description": "Whether to skip ingestion of dashboards in personal folders. Setting this to True will only ingest dashboards in the Shared folder space.",
"default": false,
"type": "boolean"
},
"max_threads": {
"title": "Max Threads",
"description": "Max parallelism for Looker API calls. Defaults to cpuCount or 40",
"default": 2,
"type": "integer"
},
"external_base_url": {
"title": "External Base Url",
"description": "Optional URL to use when constructing external URLs to Looker if the `base_url` is not the correct one to use. For example, `https://looker-public.company.com`. If not provided, the external base URL will default to `base_url`.",
"type": "string"
},
"extract_usage_history": {
"title": "Extract Usage History",
"description": "Whether to ingest usage statistics for dashboards. Setting this to True will query looker system activity explores to fetch historical dashboard usage.",
"default": true,
"type": "boolean"
},
"extract_usage_history_for_interval": {
"title": "Extract Usage History For Interval",
"description": "Used only if extract_usage_history is set to True. Interval to extract looker dashboard usage history for. See https://docs.looker.com/reference/filter-expressions#date_and_time.",
"default": "30 days",
"type": "string"
},
"extract_embed_urls": {
"title": "Extract Embed Urls",
"description": "Produce URLs used to render Looker Explores as Previews inside of DataHub UI. Embeds must be enabled inside of Looker to use this feature.",
"default": true,
"type": "boolean"
},
"extract_independent_looks": {
"title": "Extract Independent Looks",
"description": "Extract looks which are not part of any Dashboard. To enable this flag the stateful_ingestion should also be enabled.",
"default": false,
"type": "boolean"
}
},
"required": [
"client_id",
"client_secret",
"base_url"
],
"additionalProperties": false
},
"salesforce": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"salesforce"
]
},
"config": {
"$ref": "#/definitions/salesforce_config"
}
},
"required": [
"type",
"config"
]
},
"salesforce_config": {
"title": "SalesforceConfig",
"description": "Any source that is a primary producer of Dataset metadata should inherit this class",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"auth": {
"default": "USERNAME_PASSWORD",
"allOf": [
{
"$ref": "#/definitions/SalesforceAuthType"
}
]
},
"username": {
"title": "Username",
"description": "Salesforce username",
"type": "string"
},
"password": {
"title": "Password",
"description": "Password for Salesforce user",
"type": "string"
},
"consumer_key": {
"title": "Consumer Key",
"description": "Consumer key for Salesforce JSON web token access",
"type": "string"
},
"private_key": {
"title": "Private Key",
"description": "Private key as a string for Salesforce JSON web token access",
"type": "string"
},
"security_token": {
"title": "Security Token",
"description": "Security token for Salesforce username",
"type": "string"
},
"instance_url": {
"title": "Instance Url",
"description": "Salesforce instance url. e.g. https://MyDomainName.my.salesforce.com",
"type": "string"
},
"is_sandbox": {
"title": "Is Sandbox",
"description": "Connect to Sandbox instance of your Salesforce",
"default": false,
"type": "boolean"
},
"access_token": {
"title": "Access Token",
"description": "Access token for instance url",
"type": "string"
},
"ingest_tags": {
"title": "Ingest Tags",
"description": "Ingest Tags from source. This will override Tags entered from UI",
"default": false,
"type": "boolean"
},
"object_pattern": {
"title": "Object Pattern",
"description": "Regex patterns for Salesforce objects to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Regex patterns for tables/schemas to describe domain_key domain key (domain_key can be any string like \"sales\".) There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
}
},
"allOf": [
{
"$ref": "#/definitions/SalesforceProfilingConfig"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns for profiles to filter in ingestion, allowed by the `object_pattern`.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"platform": {
"title": "Platform",
"default": "salesforce",
"type": "string"
}
},
"additionalProperties": false
},
"hive": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"hive"
]
},
"config": {
"$ref": "#/definitions/hive_config"
}
},
"required": [
"type",
"config"
]
},
"hive_config": {
"title": "HiveConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Deprecated in favour of database_pattern.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "Regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"mariadb": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"mariadb"
]
},
"config": {
"$ref": "#/definitions/mariadb_config"
}
},
"required": [
"type",
"config"
]
},
"mariadb_config": {
"title": "MySQLConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Deprecated in favour of database_pattern.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "MySQL host URL.",
"default": "localhost:3306",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"default": "mysql+pymysql",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "Regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
}
},
"additionalProperties": false
},
"clickhouse": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"clickhouse"
]
},
"config": {
"$ref": "#/definitions/clickhouse_config"
}
},
"required": [
"type",
"config"
]
},
"clickhouse_config": {
"title": "ClickHouseConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "A holder for platform -> platform_instance mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Deprecated in favour of database_pattern.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"default": "",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "ClickHouse host URL.",
"default": "localhost:8123",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "Regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"secure": {
"title": "Secure",
"type": "boolean"
},
"protocol": {
"title": "Protocol",
"type": "string"
},
"uri_opts": {
"title": "Uri Opts",
"description": "The part of the URI and it's used to provide additional configuration options or parameters for the database connection.",
"default": {},
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"include_table_lineage": {
"title": "Include Table Lineage",
"description": "Whether table lineage should be ingested.",
"default": true,
"type": "boolean"
},
"include_materialized_views": {
"title": "Include Materialized Views",
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
},
"mongodb": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"mongodb"
]
},
"config": {
"$ref": "#/definitions/mongodb_config"
}
},
"required": [
"type",
"config"
]
},
"mongodb_config": {
"title": "MongoDBConfig",
"description": "Any source that produces dataset urns in a single environment should inherit this class",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"connect_uri": {
"title": "Connect Uri",
"description": "MongoDB connection URI.",
"default": "mongodb://localhost",
"type": "string"
},
"username": {
"title": "Username",
"description": "MongoDB username.",
"type": "string"
},
"password": {
"title": "Password",
"description": "MongoDB password.",
"type": "string"
},
"authMechanism": {
"title": "Authmechanism",
"description": "MongoDB authentication mechanism.",
"type": "string"
},
"options": {
"title": "Options",
"description": "Additional options to pass to `pymongo.MongoClient()`.",
"default": {},
"type": "object"
},
"enableSchemaInference": {
"title": "Enableschemainference",
"description": "Whether to infer schemas. ",
"default": true,
"type": "boolean"
},
"schemaSamplingSize": {
"title": "Schemasamplingsize",
"description": "Number of documents to use when inferring schema size. If set to `0`, all documents will be scanned.",
"default": 1000,
"exclusiveMinimum": 0,
"type": "integer"
},
"useRandomSampling": {
"title": "Userandomsampling",
"description": "If documents for schema inference should be randomly selected. If `False`, documents will be selected from start.",
"default": true,
"type": "boolean"
},
"maxSchemaSize": {
"title": "Maxschemasize",
"description": "Maximum number of fields to include in the schema.",
"default": 300,
"exclusiveMinimum": 0,
"type": "integer"
},
"maxDocumentSize": {
"title": "Maxdocumentsize",
"default": 16793600,
"exclusiveMinimum": 0,
"type": "integer"
},
"database_pattern": {
"title": "Database Pattern",
"description": "regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"collection_pattern": {
"title": "Collection Pattern",
"description": "regex patterns for collections to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
}
},
"additionalProperties": false
},
"json-schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"json-schema"
]
},
"config": {
"$ref": "#/definitions/json-schema_config"
}
},
"required": [
"type",
"config"
]
},
"json-schema_config": {
"title": "JsonSchemaSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"path": {
"title": "Path",
"description": "Set this to a single file-path or a directory-path (for recursive traversal) or a remote url. e.g. https://json.schemastore.org/petstore-v1.0.json",
"anyOf": [
{
"type": "string",
"format": "file-path"
},
{
"type": "string",
"format": "directory-path"
},
{
"type": "string",
"minLength": 1,
"maxLength": 65536,
"format": "uri"
}
]
},
"platform": {
"title": "Platform",
"description": "Set this to a platform that you want all schemas to live under. e.g. schemaregistry / schemarepo etc.",
"type": "string"
},
"use_id_as_base_uri": {
"title": "Use Id As Base Uri",
"description": "When enabled, uses the `$id` field in the json schema as the base uri for following references.",
"default": false,
"type": "boolean"
},
"uri_replace_pattern": {
"title": "Uri Replace Pattern",
"description": "Use this if URI-s need to be modified during reference resolution. Simple string match - replace capabilities are supported.",
"allOf": [
{
"$ref": "#/definitions/URIReplacePattern"
}
]
}
},
"required": [
"path",
"platform"
],
"additionalProperties": false
},
"datahub-business-glossary": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"datahub-business-glossary"
]
},
"config": {
"$ref": "#/definitions/datahub-business-glossary_config"
}
},
"required": [
"type",
"config"
]
},
"datahub-business-glossary_config": {
"title": "BusinessGlossarySourceConfig",
"type": "object",
"properties": {
"file": {
"title": "File",
"description": "File path or URL to business glossary file to ingest.",
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "path"
}
]
},
"enable_auto_id": {
"title": "Enable Auto Id",
"description": "Generate guid urns instead of a plaintext path urn with the node/term's hierarchy.",
"default": false,
"type": "boolean"
}
},
"required": [
"file"
],
"additionalProperties": false
},
"presto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"presto"
]
},
"config": {
"$ref": "#/definitions/presto_config"
}
},
"required": [
"type",
"config"
]
},
"presto_config": {
"title": "PrestoConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"redshift-legacy": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"redshift-legacy"
]
},
"config": {
"$ref": "#/definitions/redshift-legacy_config"
}
},
"required": [
"type",
"config"
]
},
"redshift-legacy_config": {
"title": "RedshiftConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"s3_lineage_config": {
"title": "S3 Lineage Config",
"description": "Common config for S3 lineage generation",
"allOf": [
{
"$ref": "#/definitions/S3LineageProviderConfig"
}
]
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "A holder for platform -> platform_instance mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"default": {
"allow": [
".*"
],
"deny": [
"information_schema"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"default_schema": {
"title": "Default Schema",
"description": "The default schema to use if the sql parser fails to parse the schema with `sql_based` lineage collector",
"default": "public",
"type": "string"
},
"include_table_lineage": {
"title": "Include Table Lineage",
"description": "Whether table lineage should be ingested.",
"default": true,
"type": "boolean"
},
"include_copy_lineage": {
"title": "Include Copy Lineage",
"description": "Whether lineage should be collected from copy commands",
"default": true,
"type": "boolean"
},
"include_unload_lineage": {
"title": "Include Unload Lineage",
"description": "Whether lineage should be collected from unload commands",
"default": true,
"type": "boolean"
},
"capture_lineage_query_parser_failures": {
"title": "Capture Lineage Query Parser Failures",
"description": "Whether to capture lineage query parser errors with dataset properties for debuggings",
"default": false,
"type": "boolean"
},
"table_lineage_mode": {
"description": "Which table lineage collector mode to use. Available modes are: [stl_scan_based, sql_based, mixed]",
"default": "stl_scan_based",
"allOf": [
{
"$ref": "#/definitions/LineageMode"
}
]
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"kafka-connect": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"kafka-connect"
]
},
"config": {
"$ref": "#/definitions/kafka-connect_config"
}
},
"required": [
"type",
"config"
]
},
"kafka-connect_config": {
"title": "KafkaConnectSourceConfig",
"description": "Any source that connects to a platform should inherit this class",
"type": "object",
"properties": {
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "Platform instance mapping to use when constructing URNs. e.g.`platform_instance_map: { \"hive\": \"warehouse\" }`",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"connect_uri": {
"title": "Connect Uri",
"description": "URI to connect to.",
"default": "http://localhost:8083/",
"type": "string"
},
"username": {
"title": "Username",
"description": "Kafka Connect username.",
"type": "string"
},
"password": {
"title": "Password",
"description": "Kafka Connect password.",
"type": "string"
},
"cluster_name": {
"title": "Cluster Name",
"description": "Cluster to ingest from.",
"default": "connect-cluster",
"type": "string"
},
"convert_lineage_urns_to_lowercase": {
"title": "Convert Lineage Urns To Lowercase",
"description": "Whether to convert the urns of ingested lineage dataset to lowercase",
"default": false,
"type": "boolean"
},
"connector_patterns": {
"title": "Connector Patterns",
"description": "regex patterns for connectors to filter for ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"provided_configs": {
"title": "Provided Configs",
"description": "Provided Configurations",
"type": "array",
"items": {
"$ref": "#/definitions/ProvidedConfig"
}
},
"connect_to_platform_map": {
"title": "Connect To Platform Map",
"description": "Platform instance mapping when multiple instances for a platform is available. Entry for a platform should be in either `platform_instance_map` or `connect_to_platform_map`. e.g.`connect_to_platform_map: { \"postgres-connector-finance-db\": \"postgres\": \"core_finance_instance\" }`",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"generic_connectors": {
"title": "Generic Connectors",
"description": "Provide lineage graph for sources connectors other than Confluent JDBC Source Connector, Debezium Source Connector, and Mongo Source Connector",
"default": [],
"type": "array",
"items": {
"$ref": "#/definitions/GenericConnectorConfig"
}
}
},
"additionalProperties": false
},
"sagemaker": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"sagemaker"
]
},
"config": {
"$ref": "#/definitions/sagemaker_config"
}
},
"required": [
"type",
"config"
]
},
"sagemaker_config": {
"title": "SagemakerSourceConfig",
"description": "Common AWS credentials config.\n\nCurrently used by:\n - Glue source\n - SageMaker source",
"type": "object",
"properties": {
"aws_access_key_id": {
"title": "Aws Access Key Id",
"description": "AWS access key ID. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_secret_access_key": {
"title": "Aws Secret Access Key",
"description": "AWS secret access key. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_session_token": {
"title": "Aws Session Token",
"description": "AWS session token. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_role": {
"title": "Aws Role",
"description": "AWS roles to assume. If using the string format, the role ARN can be specified directly. If using the object format, the role can be specified in the RoleArn field and additional available arguments are documented at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html?highlight=assume_role#STS.Client.assume_role",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/AwsAssumeRoleConfig"
}
]
}
}
]
},
"aws_profile": {
"title": "Aws Profile",
"description": "Named AWS profile to use. Only used if access key / secret are unset. If not set the default will be used",
"type": "string"
},
"aws_region": {
"title": "Aws Region",
"description": "AWS region code.",
"type": "string"
},
"aws_endpoint_url": {
"title": "Aws Endpoint Url",
"description": "The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.",
"type": "string"
},
"aws_proxy": {
"title": "Aws Proxy",
"description": "A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "regex patterns for tables to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"extract_feature_groups": {
"title": "Extract Feature Groups",
"description": "Whether to extract feature groups.",
"default": true,
"type": "boolean"
},
"extract_models": {
"title": "Extract Models",
"description": "Whether to extract models.",
"default": true,
"type": "boolean"
},
"extract_jobs": {
"title": "Extract Jobs",
"description": "Whether to extract AutoML jobs.",
"default": true,
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "string"
}
},
{
"type": "boolean"
}
]
}
},
"required": [
"aws_region"
],
"additionalProperties": false
},
"druid": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"druid"
]
},
"config": {
"$ref": "#/definitions/druid_config"
}
},
"required": [
"type",
"config"
]
},
"druid_config": {
"title": "DruidConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "regex patterns for schemas to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [
"^(lookup|sysgit|view).*"
],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"default": "druid",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
}
},
"required": [
"host_port"
],
"additionalProperties": false
},
"glue": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"glue"
]
},
"config": {
"$ref": "#/definitions/glue_config"
}
},
"required": [
"type",
"config"
]
},
"glue_config": {
"title": "GlueSourceConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"aws_access_key_id": {
"title": "Aws Access Key Id",
"description": "AWS access key ID. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_secret_access_key": {
"title": "Aws Secret Access Key",
"description": "AWS secret access key. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_session_token": {
"title": "Aws Session Token",
"description": "AWS session token. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_role": {
"title": "Aws Role",
"description": "AWS roles to assume. If using the string format, the role ARN can be specified directly. If using the object format, the role can be specified in the RoleArn field and additional available arguments are documented at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html?highlight=assume_role#STS.Client.assume_role",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/AwsAssumeRoleConfig"
}
]
}
}
]
},
"aws_profile": {
"title": "Aws Profile",
"description": "Named AWS profile to use. Only used if access key / secret are unset. If not set the default will be used",
"type": "string"
},
"aws_region": {
"title": "Aws Region",
"description": "AWS region code.",
"type": "string"
},
"aws_endpoint_url": {
"title": "Aws Endpoint Url",
"description": "The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.",
"type": "string"
},
"aws_proxy": {
"title": "Aws Proxy",
"description": "A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "regex patterns for tables to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"platform": {
"title": "Platform",
"description": "The platform to use for the dataset URNs. Must be one of ['glue', 'athena'].",
"default": "glue",
"type": "string"
},
"extract_owners": {
"title": "Extract Owners",
"description": "When enabled, extracts ownership from Glue directly and overwrites existing owners. When disabled, ownership is left empty for datasets.",
"default": true,
"type": "boolean"
},
"extract_transforms": {
"title": "Extract Transforms",
"description": "Whether to extract Glue transform jobs.",
"default": true,
"type": "boolean"
},
"ignore_unsupported_connectors": {
"title": "Ignore Unsupported Connectors",
"description": "Whether to ignore unsupported connectors. If disabled, an error will be raised.",
"default": true,
"type": "boolean"
},
"emit_s3_lineage": {
"title": "Emit S3 Lineage",
"description": "Whether to emit S3-to-Glue lineage.",
"default": false,
"type": "boolean"
},
"glue_s3_lineage_direction": {
"title": "Glue S3 Lineage Direction",
"description": "If `upstream`, S3 is upstream to Glue. If `downstream` S3 is downstream to Glue.",
"default": "upstream",
"type": "string"
},
"domain": {
"title": "Domain",
"description": "regex patterns for tables to filter to assign domain_key. ",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"catalog_id": {
"title": "Catalog Id",
"description": "The aws account id where the target glue catalog lives. If None, datahub will ingest glue in aws caller's account.",
"type": "string"
},
"ignore_resource_links": {
"title": "Ignore Resource Links",
"description": "If set to True, ignore database resource links.",
"default": false,
"type": "boolean"
},
"use_s3_bucket_tags": {
"title": "Use S3 Bucket Tags",
"description": "If an S3 Buckets Tags should be created for the Tables ingested by Glue. Please Note that this will not apply tags to any folders ingested, only the files.",
"default": false,
"type": "boolean"
},
"use_s3_object_tags": {
"title": "Use S3 Object Tags",
"description": "If an S3 Objects Tags should be created for the Tables ingested by Glue.",
"default": false,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"description": "Configs to ingest data profiles from glue table",
"allOf": [
{
"$ref": "#/definitions/GlueProfilingConfig"
}
]
}
},
"required": [
"aws_region"
],
"additionalProperties": false
},
"clickhouse-usage": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"clickhouse-usage"
]
},
"config": {
"$ref": "#/definitions/clickhouse-usage_config"
}
},
"required": [
"type",
"config"
]
},
"clickhouse-usage_config": {
"title": "ClickHouseUsageConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"top_n_queries": {
"title": "Top N Queries",
"description": "Number of top queries to save to each table.",
"default": 10,
"exclusiveMinimum": 0,
"type": "integer"
},
"user_email_pattern": {
"title": "User Email Pattern",
"description": "regex patterns for user emails to filter in usage.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_operational_stats": {
"title": "Include Operational Stats",
"description": "Whether to display operational stats.",
"default": true,
"type": "boolean"
},
"include_read_operational_stats": {
"title": "Include Read Operational Stats",
"description": "Whether to report read operational stats. Experimental.",
"default": false,
"type": "boolean"
},
"format_sql_queries": {
"title": "Format Sql Queries",
"description": "Whether to format sql queries",
"default": false,
"type": "boolean"
},
"include_top_n_queries": {
"title": "Include Top N Queries",
"description": "Whether to ingest the top_n_queries.",
"default": true,
"type": "boolean"
},
"platform_instance_map": {
"title": "Platform Instance Map",
"description": "A holder for platform -> platform_instance mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"default": {},
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Deprecated in favour of database_pattern.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"default": "",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "ClickHouse host URL.",
"default": "localhost:8123",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"database_pattern": {
"title": "Database Pattern",
"description": "Regex patterns for databases to filter in ingestion.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"secure": {
"title": "Secure",
"type": "boolean"
},
"protocol": {
"title": "Protocol",
"type": "string"
},
"uri_opts": {
"title": "Uri Opts",
"description": "The part of the URI and it's used to provide additional configuration options or parameters for the database connection.",
"default": {},
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"include_table_lineage": {
"title": "Include Table Lineage",
"description": "Whether table lineage should be ingested.",
"default": true,
"type": "boolean"
},
"include_materialized_views": {
"title": "Include Materialized Views",
"default": true,
"type": "boolean"
},
"email_domain": {
"title": "Email Domain",
"type": "string"
},
"query_log_table": {
"title": "Query Log Table",
"default": "system.query_log",
"type": "string"
}
},
"required": [
"email_domain"
],
"additionalProperties": false
},
"starburst-trino-usage": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"starburst-trino-usage"
]
},
"config": {
"$ref": "#/definitions/starburst-trino-usage_config"
}
},
"required": [
"type",
"config"
]
},
"starburst-trino-usage_config": {
"title": "TrinoUsageConfig",
"description": "Base configuration class for stateful ingestion for source configs to inherit from.",
"type": "object",
"properties": {
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"top_n_queries": {
"title": "Top N Queries",
"description": "Number of top queries to save to each table.",
"default": 10,
"exclusiveMinimum": 0,
"type": "integer"
},
"user_email_pattern": {
"title": "User Email Pattern",
"description": "regex patterns for user emails to filter in usage.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_operational_stats": {
"title": "Include Operational Stats",
"description": "Whether to display operational stats.",
"default": true,
"type": "boolean"
},
"include_read_operational_stats": {
"title": "Include Read Operational Stats",
"description": "Whether to report read operational stats. Experimental.",
"default": false,
"type": "boolean"
},
"format_sql_queries": {
"title": "Format Sql Queries",
"description": "Whether to format sql queries",
"default": false,
"type": "boolean"
},
"include_top_n_queries": {
"title": "Include Top N Queries",
"description": "Whether to ingest the top_n_queries.",
"default": true,
"type": "boolean"
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by this connector belong to",
"default": "PROD",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"description": "The instance of the platform that all assets produced by this recipe belong to",
"type": "string"
},
"stateful_ingestion": {
"$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
},
"options": {
"title": "Options",
"default": {},
"type": "object"
},
"schema_pattern": {
"title": "Schema Pattern",
"description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"view_pattern": {
"title": "View Pattern",
"description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"profile_pattern": {
"title": "Profile Pattern",
"description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"domain": {
"title": "Domain",
"description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.",
"default": {},
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AllowDenyPattern"
}
},
"include_views": {
"title": "Include Views",
"description": "Whether views should be ingested.",
"default": true,
"type": "boolean"
},
"include_tables": {
"title": "Include Tables",
"description": "Whether tables should be ingested.",
"default": true,
"type": "boolean"
},
"include_table_location_lineage": {
"title": "Include Table Location Lineage",
"description": "If the source supports it, include table lineage to the underlying storage location.",
"default": true,
"type": "boolean"
},
"profiling": {
"title": "Profiling",
"default": {
"enabled": false,
"operation_config": {
"lower_freq_profile_enabled": false,
"profile_day_of_week": null,
"profile_date_of_month": null
},
"limit": null,
"offset": null,
"report_dropped_profiles": false,
"turn_off_expensive_profiling_metrics": false,
"profile_table_level_only": false,
"include_field_null_count": true,
"include_field_distinct_count": true,
"include_field_min_value": true,
"include_field_max_value": true,
"include_field_mean_value": true,
"include_field_median_value": true,
"include_field_stddev_value": true,
"include_field_quantiles": false,
"include_field_distinct_value_frequencies": false,
"include_field_histogram": false,
"include_field_sample_values": true,
"field_sample_values_limit": 20,
"max_number_of_fields_to_profile": null,
"profile_if_updated_since_days": null,
"profile_table_size_limit": 5,
"profile_table_row_limit": 5000000,
"profile_table_row_count_estimate_only": false,
"max_workers": 10,
"query_combiner_enabled": true,
"catch_exceptions": true,
"partition_profiling_enabled": true,
"partition_datetime": null
},
"allOf": [
{
"$ref": "#/definitions/GEProfilingConfig"
}
]
},
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "host URL",
"type": "string"
},
"database": {
"title": "Database",
"description": "The name of the catalog from getting the usage",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"email_domain": {
"title": "Email Domain",
"description": "The email domain which will be appended to the users ",
"type": "string"
},
"audit_catalog": {
"title": "Audit Catalog",
"description": "The catalog name where the audit table can be found ",
"type": "string"
},
"audit_schema": {
"title": "Audit Schema",
"description": "The schema name where the audit table can be found",
"type": "string"
}
},
"required": [
"host_port",
"database",
"email_domain",
"audit_catalog",
"audit_schema"
],
"additionalProperties": false
},
"DynamicTypedStateProviderConfig": {
"title": "DynamicTypedStateProviderConfig",
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the state provider to use. For DataHub use `datahub`",
"type": "string"
},
"config": {
"title": "Config",
"description": "The configuration required for initializing the state provider. Default: The datahub_api config if set at pipeline level. Otherwise, the default DatahubClientConfig. See the defaults (https://github.com/datahub-project/datahub/blob/master/metadata-ingestion/src/datahub/ingestion/graph/client.py#L19)."
}
},
"required": [
"type"
],
"additionalProperties": false
},
"StatefulStaleMetadataRemovalConfig": {
"title": "StatefulStaleMetadataRemovalConfig",
"description": "Base specialized config for Stateful Ingestion with stale metadata removal capability.",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "The type of the ingestion state provider registered with datahub.",
"default": false,
"type": "boolean"
},
"remove_stale_metadata": {
"title": "Remove Stale Metadata",
"description": "Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.",
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
},
"AllowDenyPattern": {
"title": "AllowDenyPattern",
"description": "A class to store allow deny regexes",
"type": "object",
"properties": {
"allow": {
"title": "Allow",
"description": "List of regex patterns to include in ingestion",
"default": [
".*"
],
"type": "array",
"items": {
"type": "string"
}
},
"deny": {
"title": "Deny",
"description": "List of regex patterns to exclude from ingestion.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"ignoreCase": {
"title": "Ignorecase",
"description": "Whether to ignore case sensitivity during pattern matching.",
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
},
"OperationConfig": {
"title": "OperationConfig",
"type": "object",
"properties": {
"lower_freq_profile_enabled": {
"title": "Lower Freq Profile Enabled",
"description": "Whether to do profiling at lower freq or not. This does not do any scheduling just adds additional checks to when not to run profiling.",
"default": false,
"type": "boolean"
},
"profile_day_of_week": {
"title": "Profile Day Of Week",
"description": "Number between 0 to 6 for day of week (both inclusive). 0 is Monday and 6 is Sunday. If not specified, defaults to Nothing and this field does not take affect.",
"type": "integer"
},
"profile_date_of_month": {
"title": "Profile Date Of Month",
"description": "Number between 1 to 31 for date of month (both inclusive). If not specified, defaults to Nothing and this field does not take affect.",
"type": "integer"
}
},
"additionalProperties": false
},
"GEProfilingConfig": {
"title": "GEProfilingConfig",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "Whether profiling should be done.",
"default": false,
"type": "boolean"
},
"operation_config": {
"title": "Operation Config",
"description": "Experimental feature. To specify operation configs.",
"allOf": [
{
"$ref": "#/definitions/OperationConfig"
}
]
},
"limit": {
"title": "Limit",
"description": "Max number of documents to profile. By default, profiles all documents.",
"type": "integer"
},
"offset": {
"title": "Offset",
"description": "Offset in documents to profile. By default, uses no offset.",
"type": "integer"
},
"report_dropped_profiles": {
"title": "Report Dropped Profiles",
"description": "Whether to report datasets or dataset columns which were not profiled. Set to `True` for debugging purposes.",
"default": false,
"type": "boolean"
},
"turn_off_expensive_profiling_metrics": {
"title": "Turn Off Expensive Profiling Metrics",
"description": "Whether to turn off expensive profiling or not. This turns off profiling for quantiles, distinct_value_frequencies, histogram & sample_values. This also limits maximum number of fields being profiled to 10.",
"default": false,
"type": "boolean"
},
"profile_table_level_only": {
"title": "Profile Table Level Only",
"description": "Whether to perform profiling at table-level only, or include column-level profiling as well.",
"default": false,
"type": "boolean"
},
"include_field_null_count": {
"title": "Include Field Null Count",
"description": "Whether to profile for the number of nulls for each column.",
"default": true,
"type": "boolean"
},
"include_field_distinct_count": {
"title": "Include Field Distinct Count",
"description": "Whether to profile for the number of distinct values for each column.",
"default": true,
"type": "boolean"
},
"include_field_min_value": {
"title": "Include Field Min Value",
"description": "Whether to profile for the min value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_max_value": {
"title": "Include Field Max Value",
"description": "Whether to profile for the max value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_mean_value": {
"title": "Include Field Mean Value",
"description": "Whether to profile for the mean value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_median_value": {
"title": "Include Field Median Value",
"description": "Whether to profile for the median value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_stddev_value": {
"title": "Include Field Stddev Value",
"description": "Whether to profile for the standard deviation of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_quantiles": {
"title": "Include Field Quantiles",
"description": "Whether to profile for the quantiles of numeric columns.",
"default": false,
"type": "boolean"
},
"include_field_distinct_value_frequencies": {
"title": "Include Field Distinct Value Frequencies",
"description": "Whether to profile for distinct value frequencies.",
"default": false,
"type": "boolean"
},
"include_field_histogram": {
"title": "Include Field Histogram",
"description": "Whether to profile for the histogram for numeric fields.",
"default": false,
"type": "boolean"
},
"include_field_sample_values": {
"title": "Include Field Sample Values",
"description": "Whether to profile for the sample values for all columns.",
"default": true,
"type": "boolean"
},
"field_sample_values_limit": {
"title": "Field Sample Values Limit",
"description": "Upper limit for number of sample values to collect for all columns.",
"default": 20,
"type": "integer"
},
"max_number_of_fields_to_profile": {
"title": "Max Number Of Fields To Profile",
"description": "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"
},
"profile_if_updated_since_days": {
"title": "Profile If Updated Since Days",
"description": "Profile table only if it has been updated since these many number of days. If set to `null`, no constraint of last modified time for tables to profile. Supported only in `snowflake` and `BigQuery`.",
"exclusiveMinimum": 0,
"type": "number"
},
"profile_table_size_limit": {
"title": "Profile Table Size Limit",
"description": "Profile tables only if their size is less then specified GBs. If set to `null`, no limit on the size of tables to profile. Supported only in `snowflake` and `BigQuery`",
"default": 5,
"type": "integer"
},
"profile_table_row_limit": {
"title": "Profile Table Row Limit",
"description": "Profile tables only if their row count is less then specified count. If set to `null`, no limit on the row count of tables to profile. Supported only in `snowflake` and `BigQuery`",
"default": 5000000,
"type": "integer"
},
"profile_table_row_count_estimate_only": {
"title": "Profile Table Row Count Estimate Only",
"description": "Use an approximate query for row count. This will be much faster but slightly less accurate. Only supported for Postgres and MySQL. ",
"default": false,
"type": "boolean"
},
"max_workers": {
"title": "Max Workers",
"description": "Number of worker threads to use for profiling. Set to 1 to disable.",
"default": 10,
"type": "integer"
},
"query_combiner_enabled": {
"title": "Query Combiner Enabled",
"description": "*This feature is still experimental and can be disabled if it causes issues.* Reduces the total number of queries issued and speeds up profiling by dynamically combining SQL queries where possible.",
"default": true,
"type": "boolean"
},
"catch_exceptions": {
"title": "Catch Exceptions",
"default": true,
"type": "boolean"
},
"partition_profiling_enabled": {
"title": "Partition Profiling Enabled",
"default": true,
"type": "boolean"
},
"partition_datetime": {
"title": "Partition Datetime",
"description": "For partitioned datasets profile only the partition which matches the datetime or profile the latest one if not set. Only Bigquery supports this.",
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"StatefulIngestionConfig": {
"title": "StatefulIngestionConfig",
"description": "Basic Stateful Ingestion Specific Configuration for any source.",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "The type of the ingestion state provider registered with datahub.",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"MySQLConnectionConfig": {
"title": "MySQLConnectionConfig",
"type": "object",
"properties": {
"username": {
"title": "Username",
"description": "username",
"type": "string"
},
"password": {
"title": "Password",
"description": "password",
"type": "string",
"writeOnly": true,
"format": "password"
},
"host_port": {
"title": "Host Port",
"description": "MySQL host URL.",
"default": "localhost:3306",
"type": "string"
},
"database": {
"title": "Database",
"description": "database (catalog)",
"type": "string"
},
"database_alias": {
"title": "Database Alias",
"description": "[Deprecated] Alias to apply to database when ingesting.",
"type": "string"
},
"scheme": {
"title": "Scheme",
"default": "mysql+pymysql",
"type": "string"
},
"sqlalchemy_uri": {
"title": "Sqlalchemy Uri",
"description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.",
"type": "string"
},
"options": {
"title": "Options",
"description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.",
"type": "object"
}
},
"additionalProperties": false
},
"KafkaConsumerConnectionConfig": {
"title": "KafkaConsumerConnectionConfig",
"description": "Configuration class for holding connectivity information for Kafka consumers",
"type": "object",
"properties": {
"bootstrap": {
"title": "Bootstrap",
"default": "localhost:9092",
"type": "string"
},
"schema_registry_url": {
"title": "Schema Registry Url",
"default": "http://localhost:8080/schema-registry/api/",
"type": "string"
},
"schema_registry_config": {
"title": "Schema Registry Config",
"description": "Extra schema registry config serialized as JSON. These options will be passed into Kafka's SchemaRegistryClient. https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html?#schemaregistryclient",
"type": "object"
},
"client_timeout_seconds": {
"title": "Client Timeout Seconds",
"description": "The request timeout used when interacting with the Kafka APIs.",
"default": 60,
"type": "integer"
},
"consumer_config": {
"title": "Consumer Config",
"description": "Extra consumer config serialized as JSON. These options will be passed into Kafka's DeserializingConsumer. See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#deserializingconsumer and https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md .",
"type": "object"
}
},
"additionalProperties": false
},
"BucketDuration": {
"title": "BucketDuration",
"description": "An enumeration.",
"enum": [
"DAY",
"HOUR"
],
"type": "string"
},
"BigQueryUsageConfig": {
"title": "BigQueryUsageConfig",
"type": "object",
"properties": {
"bucket_duration": {
"description": "Size of the time window to aggregate usage stats.",
"default": "DAY",
"allOf": [
{
"$ref": "#/definitions/BucketDuration"
}
]
},
"end_time": {
"title": "End Time",
"description": "Latest date of lineage/usage to consider. Default: Current time in UTC",
"type": "string",
"format": "date-time"
},
"start_time": {
"title": "Start Time",
"description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.",
"type": "string",
"format": "date-time"
},
"top_n_queries": {
"title": "Top N Queries",
"description": "Number of top queries to save to each table.",
"default": 10,
"exclusiveMinimum": 0,
"type": "integer"
},
"user_email_pattern": {
"title": "User Email Pattern",
"description": "regex patterns for user emails to filter in usage.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"include_operational_stats": {
"title": "Include Operational Stats",
"description": "Whether to display operational stats.",
"default": true,
"type": "boolean"
},
"include_read_operational_stats": {
"title": "Include Read Operational Stats",
"description": "Whether to report read operational stats. Experimental.",
"default": false,
"type": "boolean"
},
"format_sql_queries": {
"title": "Format Sql Queries",
"description": "Whether to format sql queries",
"default": false,
"type": "boolean"
},
"include_top_n_queries": {
"title": "Include Top N Queries",
"description": "Whether to ingest the top_n_queries.",
"default": true,
"type": "boolean"
},
"max_query_duration": {
"title": "Max Query Duration",
"description": "Correction to pad start_time and end_time with. For handling the case where the read happens within our time range but the query completion event is delayed and happens after the configured end time.",
"default": 900.0,
"type": "number",
"format": "time-delta"
},
"apply_view_usage_to_tables": {
"title": "Apply View Usage To Tables",
"description": "Whether to apply view's usage to its base tables. If set to False, uses sql parser and applies usage to views / tables mentioned in the query. If set to True, usage is applied to base tables only.",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"BigQueryCredential": {
"title": "BigQueryCredential",
"type": "object",
"properties": {
"project_id": {
"title": "Project Id",
"description": "Project id to set the credentials",
"type": "string"
},
"private_key_id": {
"title": "Private Key Id",
"description": "Private key id",
"type": "string"
},
"private_key": {
"title": "Private Key",
"description": "Private key in a form of '-----BEGIN PRIVATE KEY-----\\nprivate-key\\n-----END PRIVATE KEY-----\\n'",
"type": "string"
},
"client_email": {
"title": "Client Email",
"description": "Client email",
"type": "string"
},
"client_id": {
"title": "Client Id",
"description": "Client Id",
"type": "string"
},
"auth_uri": {
"title": "Auth Uri",
"description": "Authentication uri",
"default": "https://accounts.google.com/o/oauth2/auth",
"type": "string"
},
"token_uri": {
"title": "Token Uri",
"description": "Token uri",
"default": "https://oauth2.googleapis.com/token",
"type": "string"
},
"auth_provider_x509_cert_url": {
"title": "Auth Provider X509 Cert Url",
"description": "Auth provider x509 certificate url",
"default": "https://www.googleapis.com/oauth2/v1/certs",
"type": "string"
},
"type": {
"title": "Type",
"description": "Authentication type",
"default": "service_account",
"type": "string"
},
"client_x509_cert_url": {
"title": "Client X509 Cert Url",
"description": "If not set it will be default to https://www.googleapis.com/robot/v1/metadata/x509/client_email",
"type": "string"
}
},
"required": [
"project_id",
"private_key_id",
"private_key",
"client_email",
"client_id"
],
"additionalProperties": false
},
"LookerNamingPattern": {
"title": "LookerNamingPattern",
"type": "object",
"properties": {
"pattern": {
"title": "Pattern",
"type": "string"
}
},
"required": [
"pattern"
],
"additionalProperties": false
},
"GitInfo": {
"title": "GitInfo",
"description": "A reference to a Git repository, including a deploy key that can be used to clone it.",
"type": "object",
"properties": {
"repo": {
"title": "Repo",
"description": "Name of your Git repo e.g. https://github.com/datahub-project/datahub or https://gitlab.com/gitlab-org/gitlab. If organization/repo is provided, we assume it is a GitHub repo.",
"type": "string"
},
"branch": {
"title": "Branch",
"description": "Branch on which your files live by default. Typically main or master. This can also be a commit hash.",
"default": "main",
"type": "string"
},
"url_template": {
"title": "Url Template",
"description": "Template for generating a URL to a file in the repo e.g. '{repo_url}/blob/{branch}/{file_path}'. We can infer this for GitHub and GitLab repos, and it is otherwise required.It supports the following variables: {repo_url}, {branch}, {file_path}",
"type": "string"
},
"deploy_key_file": {
"title": "Deploy Key File",
"description": "A private key file that contains an ssh key that has been configured as a deploy key for this repository. Use a file where possible, else see deploy_key for a config field that accepts a raw string.",
"format": "file-path",
"type": "string"
},
"deploy_key": {
"title": "Deploy Key",
"description": "A private key that contains an ssh key that has been configured as a deploy key for this repository. See deploy_key_file if you want to use a file that contains this key.",
"type": "string",
"writeOnly": true,
"format": "password"
},
"repo_ssh_locator": {
"title": "Repo Ssh Locator",
"description": "The url to call `git clone` on. We infer this for github and gitlab repos, but it is required for other hosts.",
"type": "string"
}
},
"required": [
"repo"
],
"additionalProperties": false
},
"LookerConnectionDefinition": {
"title": "LookerConnectionDefinition",
"type": "object",
"properties": {
"platform": {
"title": "Platform",
"type": "string"
},
"default_db": {
"title": "Default Db",
"type": "string"
},
"default_schema": {
"title": "Default Schema",
"type": "string"
},
"platform_instance": {
"title": "Platform Instance",
"type": "string"
},
"platform_env": {
"title": "Platform Env",
"description": "The environment that the platform is located in. Leaving this empty will inherit defaults from the top level Looker configuration",
"type": "string"
}
},
"required": [
"platform",
"default_db"
],
"additionalProperties": false
},
"TransportOptionsConfig": {
"title": "TransportOptionsConfig",
"type": "object",
"properties": {
"timeout": {
"title": "Timeout",
"type": "integer"
},
"headers": {
"title": "Headers",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"timeout",
"headers"
],
"additionalProperties": false
},
"LookerAPIConfig": {
"title": "LookerAPIConfig",
"type": "object",
"properties": {
"client_id": {
"title": "Client Id",
"description": "Looker API client id.",
"type": "string"
},
"client_secret": {
"title": "Client Secret",
"description": "Looker API client secret.",
"type": "string"
},
"base_url": {
"title": "Base Url",
"description": "Url to your Looker instance: `https://company.looker.com:19999` or `https://looker.company.com`, or similar. Used for making API calls to Looker and constructing clickable dashboard and chart urls.",
"type": "string"
},
"transport_options": {
"title": "Transport Options",
"description": "Populates the [TransportOptions](https://github.com/looker-open-source/sdk-codegen/blob/94d6047a0d52912ac082eb91616c1e7c379ab262/python/looker_sdk/rtl/transport.py#L70) struct for looker client",
"allOf": [
{
"$ref": "#/definitions/TransportOptionsConfig"
}
]
}
},
"required": [
"client_id",
"client_secret",
"base_url"
],
"additionalProperties": false
},
"PathSpec": {
"title": "PathSpec",
"type": "object",
"properties": {
"include": {
"title": "Include",
"description": "Path to table. Name variable `{table}` is used to mark the folder with dataset. In absence of `{table}`, file level dataset will be created. Check below examples for more details.",
"type": "string"
},
"exclude": {
"title": "Exclude",
"description": "list of paths in glob pattern which will be excluded while scanning for the datasets",
"type": "array",
"items": {
"type": "string"
}
},
"file_types": {
"title": "File Types",
"description": "Files with extenstions specified here (subset of default value) only will be scanned to create dataset. Other files will be omitted.",
"default": [
"csv",
"tsv",
"json",
"parquet",
"avro"
],
"type": "array",
"items": {
"type": "string"
}
},
"default_extension": {
"title": "Default Extension",
"description": "For files without extension it will assume the specified file type. If it is not set the files without extensions will be skipped.",
"type": "string"
},
"table_name": {
"title": "Table Name",
"description": "Display name of the dataset.Combination of named variables from include path and strings",
"type": "string"
},
"enable_compression": {
"title": "Enable Compression",
"description": "Enable or disable processing compressed files. Currently .gz and .bz files are supported.",
"default": true,
"type": "boolean"
},
"sample_files": {
"title": "Sample Files",
"description": "Not listing all the files but only taking a handful amount of sample file to infer the schema. File count and file size calculation will be disabled. This can affect performance significantly if enabled",
"default": true,
"type": "boolean"
}
},
"required": [
"include"
],
"additionalProperties": false
},
"S3LineageProviderConfig": {
"title": "S3LineageProviderConfig",
"description": "Any source that produces s3 lineage from/to Datasets should inherit this class.",
"type": "object",
"properties": {
"path_specs": {
"title": "Path Specs",
"description": "List of PathSpec. See below the details about PathSpec",
"type": "array",
"items": {
"$ref": "#/definitions/PathSpec"
}
}
},
"required": [
"path_specs"
],
"additionalProperties": false
},
"LineageMode": {
"title": "LineageMode",
"description": "An enumeration.",
"enum": [
"sql_based",
"stl_scan_based",
"mixed"
]
},
"EmitDirective": {
"title": "EmitDirective",
"description": "A holder for directives for emission for specific types of entities",
"enum": [
"YES",
"NO",
"ONLY"
]
},
"DBTEntitiesEnabled": {
"title": "DBTEntitiesEnabled",
"description": "Controls which dbt entities are going to be emitted by this source",
"type": "object",
"properties": {
"models": {
"description": "Emit metadata for dbt models when set to Yes or Only",
"default": "YES",
"allOf": [
{
"$ref": "#/definitions/EmitDirective"
}
]
},
"sources": {
"description": "Emit metadata for dbt sources when set to Yes or Only",
"default": "YES",
"allOf": [
{
"$ref": "#/definitions/EmitDirective"
}
]
},
"seeds": {
"description": "Emit metadata for dbt seeds when set to Yes or Only",
"default": "YES",
"allOf": [
{
"$ref": "#/definitions/EmitDirective"
}
]
},
"snapshots": {
"description": "Emit metadata for dbt snapshots when set to Yes or Only",
"default": "YES",
"allOf": [
{
"$ref": "#/definitions/EmitDirective"
}
]
},
"test_definitions": {
"description": "Emit metadata for test definitions when enabled when set to Yes or Only",
"default": "YES",
"allOf": [
{
"$ref": "#/definitions/EmitDirective"
}
]
},
"test_results": {
"description": "Emit metadata for test results when set to Yes or Only",
"default": "YES",
"allOf": [
{
"$ref": "#/definitions/EmitDirective"
}
]
}
},
"additionalProperties": false
},
"AwsAssumeRoleConfig": {
"title": "AwsAssumeRoleConfig",
"type": "object",
"properties": {
"RoleArn": {
"title": "Rolearn",
"description": "ARN of the role to assume.",
"type": "string"
},
"ExternalId": {
"title": "Externalid",
"description": "External ID to use when assuming the role.",
"type": "string"
}
},
"required": [
"RoleArn"
]
},
"AwsConnectionConfig": {
"title": "AwsConnectionConfig",
"description": "Common AWS credentials config.\n\nCurrently used by:\n - Glue source\n - SageMaker source\n - dbt source",
"type": "object",
"properties": {
"aws_access_key_id": {
"title": "Aws Access Key Id",
"description": "AWS access key ID. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_secret_access_key": {
"title": "Aws Secret Access Key",
"description": "AWS secret access key. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_session_token": {
"title": "Aws Session Token",
"description": "AWS session token. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.",
"type": "string"
},
"aws_role": {
"title": "Aws Role",
"description": "AWS roles to assume. If using the string format, the role ARN can be specified directly. If using the object format, the role can be specified in the RoleArn field and additional available arguments are documented at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html?highlight=assume_role#STS.Client.assume_role",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/AwsAssumeRoleConfig"
}
]
}
}
]
},
"aws_profile": {
"title": "Aws Profile",
"description": "Named AWS profile to use. Only used if access key / secret are unset. If not set the default will be used",
"type": "string"
},
"aws_region": {
"title": "Aws Region",
"description": "AWS region code.",
"type": "string"
},
"aws_endpoint_url": {
"title": "Aws Endpoint Url",
"description": "The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.",
"type": "string"
},
"aws_proxy": {
"title": "Aws Proxy",
"description": "A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"aws_region"
],
"additionalProperties": false
},
"GitReference": {
"title": "GitReference",
"description": "Reference to a hosted Git repository. Used to generate \"view source\" links.",
"type": "object",
"properties": {
"repo": {
"title": "Repo",
"description": "Name of your Git repo e.g. https://github.com/datahub-project/datahub or https://gitlab.com/gitlab-org/gitlab. If organization/repo is provided, we assume it is a GitHub repo.",
"type": "string"
},
"branch": {
"title": "Branch",
"description": "Branch on which your files live by default. Typically main or master. This can also be a commit hash.",
"default": "main",
"type": "string"
},
"url_template": {
"title": "Url Template",
"description": "Template for generating a URL to a file in the repo e.g. '{repo_url}/blob/{branch}/{file_path}'. We can infer this for GitHub and GitLab repos, and it is otherwise required.It supports the following variables: {repo_url}, {branch}, {file_path}",
"type": "string"
}
},
"required": [
"repo"
],
"additionalProperties": false
},
"PrestoOnHiveConfigMode": {
"title": "PrestoOnHiveConfigMode",
"description": "An enumeration.",
"enum": [
"hive",
"presto",
"presto-on-hive",
"trino"
],
"type": "string"
},
"PlatformDetail": {
"title": "PlatformDetail",
"type": "object",
"properties": {
"platform_instance": {
"title": "Platform Instance",
"description": "DataHub platform instance name. To generate correct urn for upstream dataset, this should match with platform instance name used in ingestion recipe of other datahub sources.",
"type": "string"
},
"env": {
"title": "Env",
"description": "The environment that all assets produced by DataHub platform ingestion source belong to",
"default": "PROD",
"type": "string"
}
},
"additionalProperties": false
},
"OwnershipMapping": {
"title": "OwnershipMapping",
"type": "object",
"properties": {
"create_corp_user": {
"title": "Create Corp User",
"description": "Whether ingest PowerBI user as Datahub Corpuser",
"default": true,
"type": "boolean"
},
"use_powerbi_email": {
"title": "Use Powerbi Email",
"description": "Use PowerBI User email to ingest as corpuser, default is powerbi user identifier",
"default": false,
"type": "boolean"
},
"remove_email_suffix": {
"title": "Remove Email Suffix",
"description": "Remove PowerBI User email suffix for example, @acryl.io",
"default": false,
"type": "boolean"
},
"dataset_configured_by_as_owner": {
"title": "Dataset Configured By As Owner",
"description": "Take PBI dataset configuredBy as dataset owner if exist",
"default": false,
"type": "boolean"
},
"owner_criteria": {
"title": "Owner Criteria",
"description": "Need to have certain authority to qualify as owner for example ['ReadWriteReshareExplore','Owner','Admin']",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"ElasticProfiling": {
"title": "ElasticProfiling",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "Whether to enable profiling for the elastic search source.",
"default": false,
"type": "boolean"
},
"operation_config": {
"title": "Operation Config",
"description": "Experimental feature. To specify operation configs.",
"allOf": [
{
"$ref": "#/definitions/OperationConfig"
}
]
}
},
"additionalProperties": false
},
"CollapseUrns": {
"title": "CollapseUrns",
"type": "object",
"properties": {
"urns_suffix_regex": {
"title": "Urns Suffix Regex",
"description": "List of regex patterns to remove from the name of the URN. All of the indices before removal of URNs are considered as the same dataset. These are applied in order for each URN.\n The main case where you would want to have multiple of these if the name where you are trying to remove suffix from have different formats.\n e.g. ending with -YYYY-MM-DD as well as ending -epochtime would require you to have 2 regex patterns to remove the suffixes across all URNs.",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"DynamicTypedClassifierConfig": {
"title": "DynamicTypedClassifierConfig",
"type": "object",
"properties": {
"type": {
"title": "Type",
"description": "The type of the classifier to use. For DataHub, use `datahub`",
"type": "string"
},
"config": {
"title": "Config",
"description": "The configuration required for initializing the classifier. If not specified, uses defaults for classifer type."
}
},
"required": [
"type"
],
"additionalProperties": false
},
"ClassificationConfig": {
"title": "ClassificationConfig",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "Whether classification should be used to auto-detect glossary terms",
"default": false,
"type": "boolean"
},
"sample_size": {
"title": "Sample Size",
"description": "Number of sample values used for classification.",
"default": 100,
"type": "integer"
},
"max_workers": {
"title": "Max Workers",
"description": "Number of worker threads to use for classification. Set to 1 to disable.",
"default": 2,
"type": "integer"
},
"table_pattern": {
"title": "Table Pattern",
"description": "Regex patterns to filter tables for classification. This is used in combination with other patterns in parent config. Specify regex to match the entire table name in `database.schema.table` format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"column_pattern": {
"title": "Column Pattern",
"description": "Regex patterns to filter columns for classification. This is used in combination with other patterns in parent config. Specify regex to match the column name in `database.schema.table.column` format.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"info_type_to_term": {
"title": "Info Type To Term",
"description": "Optional mapping to provide glossary term identifier for info type",
"default": {},
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"classifiers": {
"title": "Classifiers",
"description": "Classifiers to use to auto-detect glossary terms. If more than one classifier, infotype predictions from the classifier defined later in sequence take precedance.",
"default": [
{
"type": "datahub",
"config": null
}
],
"type": "array",
"items": {
"$ref": "#/definitions/DynamicTypedClassifierConfig"
}
}
},
"additionalProperties": false
},
"OAuthIdentityProvider": {
"title": "OAuthIdentityProvider",
"description": "An enumeration.",
"enum": [
"microsoft",
"okta"
]
},
"OAuthConfiguration": {
"title": "OAuthConfiguration",
"type": "object",
"properties": {
"provider": {
"description": "Identity provider for oauth.Supported providers are microsoft and okta.",
"allOf": [
{
"$ref": "#/definitions/OAuthIdentityProvider"
}
]
},
"authority_url": {
"title": "Authority Url",
"description": "Authority url of your identity provider",
"type": "string"
},
"client_id": {
"title": "Client Id",
"description": "client id of your registered application",
"type": "string"
},
"scopes": {
"title": "Scopes",
"description": "scopes required to connect to snowflake",
"type": "array",
"items": {
"type": "string"
}
},
"use_certificate": {
"title": "Use Certificate",
"description": "Do you want to use certificate and private key to authenticate using oauth",
"default": false,
"type": "boolean"
},
"client_secret": {
"title": "Client Secret",
"description": "client secret of the application if use_certificate = false",
"type": "string",
"writeOnly": true,
"format": "password"
},
"encoded_oauth_public_key": {
"title": "Encoded Oauth Public Key",
"description": "base64 encoded certificate content if use_certificate = true",
"type": "string"
},
"encoded_oauth_private_key": {
"title": "Encoded Oauth Private Key",
"description": "base64 encoded private key content if use_certificate = true",
"type": "string"
}
},
"required": [
"provider",
"authority_url",
"client_id",
"scopes"
],
"additionalProperties": false
},
"TagOption": {
"title": "TagOption",
"description": "An enumeration.",
"enum": [
"with_lineage",
"without_lineage",
"skip"
],
"type": "string"
},
"UnityCatalogProfilerConfig": {
"title": "UnityCatalogProfilerConfig",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "Whether profiling should be done.",
"default": false,
"type": "boolean"
},
"operation_config": {
"title": "Operation Config",
"description": "Experimental feature. To specify operation configs.",
"allOf": [
{
"$ref": "#/definitions/OperationConfig"
}
]
},
"warehouse_id": {
"title": "Warehouse Id",
"description": "SQL Warehouse id, for running profiling queries.",
"type": "string"
},
"profile_table_level_only": {
"title": "Profile Table Level Only",
"description": "Whether to perform profiling at table-level only or include column-level profiling as well.",
"default": false,
"type": "boolean"
},
"pattern": {
"title": "Pattern",
"description": "Regex patterns to filter tables for profiling during ingestion. Specify regex to match the `catalog.schema.table` format. Note that only tables allowed by the `table_pattern` will be considered.",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"call_analyze": {
"title": "Call Analyze",
"description": "Whether to call ANALYZE TABLE as part of profile ingestion.If false, will ingest the results of the most recent ANALYZE TABLE call, if any.",
"default": true,
"type": "boolean"
},
"max_wait_secs": {
"title": "Max Wait Secs",
"description": "Maximum time to wait for an ANALYZE TABLE query to complete.",
"default": 3600,
"type": "integer"
},
"max_workers": {
"title": "Max Workers",
"description": "Number of worker threads to use for profiling. Set to 1 to disable.",
"default": 10,
"type": "integer"
}
},
"additionalProperties": false
},
"ModeAPIConfig": {
"title": "ModeAPIConfig",
"type": "object",
"properties": {
"retry_backoff_multiplier": {
"title": "Retry Backoff Multiplier",
"description": "Multiplier for exponential backoff when waiting to retry",
"default": 2,
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
},
"max_retry_interval": {
"title": "Max Retry Interval",
"description": "Maximum interval to wait when retrying",
"default": 10,
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
},
"max_attempts": {
"title": "Max Attempts",
"description": "Maximum number of attempts to retry before failing",
"default": 5,
"type": "integer"
}
},
"additionalProperties": false
},
"AdlsSourceConfig": {
"title": "AdlsSourceConfig",
"description": "Common Azure credentials config.\n\nhttps://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-directory-file-acl-python",
"type": "object",
"properties": {
"base_path": {
"title": "Base Path",
"description": "Base folder in hierarchical namespaces to start from.",
"default": "/",
"type": "string"
},
"container_name": {
"title": "Container Name",
"description": "Azure storage account container name.",
"type": "string"
},
"account_name": {
"title": "Account Name",
"description": "Name of the Azure storage account. See [Microsoft official documentation on how to create a storage account.](https://docs.microsoft.com/en-us/azure/storage/blobs/create-data-lake-storage-account)",
"type": "string"
},
"account_key": {
"title": "Account Key",
"description": "Azure storage account access key that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**",
"type": "string"
},
"sas_token": {
"title": "Sas Token",
"description": "Azure storage account Shared Access Signature (SAS) token that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**",
"type": "string"
},
"client_secret": {
"title": "Client Secret",
"description": "Azure client secret that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**",
"type": "string"
},
"client_id": {
"title": "Client Id",
"description": "Azure client (Application) ID required when a `client_secret` is used as a credential.",
"type": "string"
},
"tenant_id": {
"title": "Tenant Id",
"description": "Azure tenant (Directory) ID required when a `client_secret` is used as a credential.",
"type": "string"
}
},
"required": [
"container_name",
"account_name"
],
"additionalProperties": false
},
"IcebergProfilingConfig": {
"title": "IcebergProfilingConfig",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "Whether profiling should be done.",
"default": false,
"type": "boolean"
},
"include_field_null_count": {
"title": "Include Field Null Count",
"description": "Whether to profile for the number of nulls for each column.",
"default": true,
"type": "boolean"
},
"include_field_min_value": {
"title": "Include Field Min Value",
"description": "Whether to profile for the min value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_max_value": {
"title": "Include Field Max Value",
"description": "Whether to profile for the max value of numeric columns.",
"default": true,
"type": "boolean"
},
"operation_config": {
"title": "Operation Config",
"description": "Experimental feature. To specify operation configs.",
"allOf": [
{
"$ref": "#/definitions/OperationConfig"
}
]
}
},
"additionalProperties": false
},
"S3": {
"title": "S3",
"type": "object",
"properties": {
"aws_config": {
"title": "Aws Config",
"description": "AWS configuration",
"allOf": [
{
"$ref": "#/definitions/AwsConnectionConfig"
}
]
},
"use_s3_bucket_tags": {
"title": "Use S3 Bucket Tags",
"description": "Whether or not to create tags in datahub from the s3 bucket",
"default": false,
"type": "boolean"
},
"use_s3_object_tags": {
"title": "Use S3 Object Tags",
"description": "# Whether or not to create tags in datahub from the s3 object",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"HMACKey": {
"title": "HMACKey",
"type": "object",
"properties": {
"hmac_access_id": {
"title": "Hmac Access Id",
"description": "Access ID",
"type": "string"
},
"hmac_access_secret": {
"title": "Hmac Access Secret",
"description": "Secret",
"type": "string",
"writeOnly": true,
"format": "password"
}
},
"required": [
"hmac_access_id",
"hmac_access_secret"
],
"additionalProperties": false
},
"TableauLineageOverrides": {
"title": "TableauLineageOverrides",
"type": "object",
"properties": {
"platform_override_map": {
"title": "Platform Override Map",
"description": "A holder for platform -> platform mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"database_override_map": {
"title": "Database Override Map",
"description": "A holder for database -> database mappings to generate correct dataset urns",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false
},
"NifiAuthType": {
"title": "NifiAuthType",
"description": "An enumeration.",
"enum": [
"NO_AUTH",
"SINGLE_USER",
"CLIENT_CERT",
"KERBEROS",
"BASIC_AUTH"
]
},
"FileReadMode": {
"title": "FileReadMode",
"description": "An enumeration.",
"enum": [
"STREAM",
"BATCH",
"AUTO"
]
},
"DataLakeProfilerConfig": {
"title": "DataLakeProfilerConfig",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "Whether profiling should be done.",
"default": false,
"type": "boolean"
},
"operation_config": {
"title": "Operation Config",
"description": "Experimental feature. To specify operation configs.",
"allOf": [
{
"$ref": "#/definitions/OperationConfig"
}
]
},
"profile_table_level_only": {
"title": "Profile Table Level Only",
"description": "Whether to perform profiling at table-level only or include column-level profiling as well.",
"default": false,
"type": "boolean"
},
"max_number_of_fields_to_profile": {
"title": "Max Number Of Fields To Profile",
"description": "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"
},
"include_field_null_count": {
"title": "Include Field Null Count",
"description": "Whether to profile for the number of nulls for each column.",
"default": true,
"type": "boolean"
},
"include_field_min_value": {
"title": "Include Field Min Value",
"description": "Whether to profile for the min value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_max_value": {
"title": "Include Field Max Value",
"description": "Whether to profile for the max value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_mean_value": {
"title": "Include Field Mean Value",
"description": "Whether to profile for the mean value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_median_value": {
"title": "Include Field Median Value",
"description": "Whether to profile for the median value of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_stddev_value": {
"title": "Include Field Stddev Value",
"description": "Whether to profile for the standard deviation of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_quantiles": {
"title": "Include Field Quantiles",
"description": "Whether to profile for the quantiles of numeric columns.",
"default": true,
"type": "boolean"
},
"include_field_distinct_value_frequencies": {
"title": "Include Field Distinct Value Frequencies",
"description": "Whether to profile for distinct value frequencies.",
"default": true,
"type": "boolean"
},
"include_field_histogram": {
"title": "Include Field Histogram",
"description": "Whether to profile for the histogram for numeric fields.",
"default": true,
"type": "boolean"
},
"include_field_sample_values": {
"title": "Include Field Sample Values",
"description": "Whether to profile for the sample values for all columns.",
"default": true,
"type": "boolean"
}
},
"additionalProperties": false
},
"SalesforceAuthType": {
"title": "SalesforceAuthType",
"description": "An enumeration.",
"enum": [
"USERNAME_PASSWORD",
"DIRECT_ACCESS_TOKEN",
"JSON_WEB_TOKEN"
]
},
"SalesforceProfilingConfig": {
"title": "SalesforceProfilingConfig",
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"description": "Whether profiling should be done. Supports only table-level profiling at this stage",
"default": false,
"type": "boolean"
},
"operation_config": {
"title": "Operation Config",
"description": "Experimental feature. To specify operation configs.",
"allOf": [
{
"$ref": "#/definitions/OperationConfig"
}
]
}
},
"additionalProperties": false
},
"URIReplacePattern": {
"title": "URIReplacePattern",
"type": "object",
"properties": {
"match": {
"title": "Match",
"description": "Pattern to match on uri-s as part of reference resolution. See replace field",
"type": "string"
},
"replace": {
"title": "Replace",
"description": "Pattern to replace with as part of reference resolution. See match field",
"type": "string"
}
},
"required": [
"match",
"replace"
],
"additionalProperties": false
},
"ProvidedConfig": {
"title": "ProvidedConfig",
"type": "object",
"properties": {
"provider": {
"title": "Provider",
"type": "string"
},
"path_key": {
"title": "Path Key",
"type": "string"
},
"value": {
"title": "Value",
"type": "string"
}
},
"required": [
"provider",
"path_key",
"value"
],
"additionalProperties": false
},
"GenericConnectorConfig": {
"title": "GenericConnectorConfig",
"type": "object",
"properties": {
"connector_name": {
"title": "Connector Name",
"type": "string"
},
"source_dataset": {
"title": "Source Dataset",
"type": "string"
},
"source_platform": {
"title": "Source Platform",
"type": "string"
}
},
"required": [
"connector_name",
"source_dataset",
"source_platform"
],
"additionalProperties": false
},
"GlueProfilingConfig": {
"title": "GlueProfilingConfig",
"type": "object",
"properties": {
"row_count": {
"title": "Row Count",
"description": "The parameter name for row count in glue table.",
"type": "string"
},
"column_count": {
"title": "Column Count",
"description": "The parameter name for column count in glue table.",
"type": "string"
},
"unique_count": {
"title": "Unique Count",
"description": "The parameter name for the count of unique value in a column.",
"type": "string"
},
"unique_proportion": {
"title": "Unique Proportion",
"description": "The parameter name for the proportion of unique values in a column.",
"type": "string"
},
"null_count": {
"title": "Null Count",
"description": "The parameter name for the count of null values in a column.",
"type": "string"
},
"null_proportion": {
"title": "Null Proportion",
"description": "The parameter name for the proportion of null values in a column.",
"type": "string"
},
"min": {
"title": "Min",
"description": "The parameter name for the min value of a column.",
"type": "string"
},
"max": {
"title": "Max",
"description": "The parameter name for the max value of a column.",
"type": "string"
},
"mean": {
"title": "Mean",
"description": "The parameter name for the mean value of a column.",
"type": "string"
},
"median": {
"title": "Median",
"description": "The parameter name for the median value of a column.",
"type": "string"
},
"stdev": {
"title": "Stdev",
"description": "The parameter name for the standard deviation of a column.",
"type": "string"
},
"partition_patterns": {
"title": "Partition Patterns",
"description": "Regex patterns for filtering partitions for profile. The pattern should be a string like: \"{'key':'value'}\".",
"default": {
"allow": [
".*"
],
"deny": [],
"ignoreCase": true
},
"allOf": [
{
"$ref": "#/definitions/AllowDenyPattern"
}
]
},
"operation_config": {
"title": "Operation Config",
"description": "Experimental feature. To specify operation configs.",
"allOf": [
{
"$ref": "#/definitions/OperationConfig"
}
]
}
},
"additionalProperties": false
}
},
"type": "object",
"properties": {
"source": {
"anyOf": [
{
"$ref": "#/definitions/mysql"
},
{
"$ref": "#/definitions/oracle"
},
{
"$ref": "#/definitions/powerbi-report-server"
},
{
"$ref": "#/definitions/datahub"
},
{
"$ref": "#/definitions/bigquery"
},
{
"$ref": "#/definitions/okta"
},
{
"$ref": "#/definitions/lookml"
},
{
"$ref": "#/definitions/redshift"
},
{
"$ref": "#/definitions/redshift-usage-legacy"
},
{
"$ref": "#/definitions/demo-data"
},
{
"$ref": "#/definitions/vertica"
},
{
"$ref": "#/definitions/redash"
},
{
"$ref": "#/definitions/dbt"
},
{
"$ref": "#/definitions/presto-on-hive"
},
{
"$ref": "#/definitions/powerbi"
},
{
"$ref": "#/definitions/elasticsearch"
},
{
"$ref": "#/definitions/snowflake"
},
{
"$ref": "#/definitions/superset"
},
{
"$ref": "#/definitions/unity-catalog"
},
{
"$ref": "#/definitions/feast"
},
{
"$ref": "#/definitions/mode"
},
{
"$ref": "#/definitions/sqlalchemy"
},
{
"$ref": "#/definitions/hana"
},
{
"$ref": "#/definitions/iceberg"
},
{
"$ref": "#/definitions/pulsar"
},
{
"$ref": "#/definitions/delta-lake"
},
{
"$ref": "#/definitions/azure-ad"
},
{
"$ref": "#/definitions/openapi"
},
{
"$ref": "#/definitions/kafka"
},
{
"$ref": "#/definitions/datahub-lineage-file"
},
{
"$ref": "#/definitions/postgres"
},
{
"$ref": "#/definitions/gcs"
},
{
"$ref": "#/definitions/csv-enricher"
},
{
"$ref": "#/definitions/metabase"
},
{
"$ref": "#/definitions/athena"
},
{
"$ref": "#/definitions/trino"
},
{
"$ref": "#/definitions/tableau"
},
{
"$ref": "#/definitions/mssql"
},
{
"$ref": "#/definitions/nifi"
},
{
"$ref": "#/definitions/ldap"
},
{
"$ref": "#/definitions/dbt-cloud"
},
{
"$ref": "#/definitions/file"
},
{
"$ref": "#/definitions/s3"
},
{
"$ref": "#/definitions/looker"
},
{
"$ref": "#/definitions/salesforce"
},
{
"$ref": "#/definitions/hive"
},
{
"$ref": "#/definitions/mariadb"
},
{
"$ref": "#/definitions/clickhouse"
},
{
"$ref": "#/definitions/mongodb"
},
{
"$ref": "#/definitions/json-schema"
},
{
"$ref": "#/definitions/datahub-business-glossary"
},
{
"$ref": "#/definitions/presto"
},
{
"$ref": "#/definitions/redshift-legacy"
},
{
"$ref": "#/definitions/kafka-connect"
},
{
"$ref": "#/definitions/sagemaker"
},
{
"$ref": "#/definitions/druid"
},
{
"$ref": "#/definitions/glue"
},
{
"$ref": "#/definitions/clickhouse-usage"
},
{
"$ref": "#/definitions/starburst-trino-usage"
}
]
},
"transformers": {
"type": "array",
"items": {
"type": "object",
"description": "Transformer configs see at https://datahubproject.io/docs/metadata-ingestion/docs/transformer",
"properties": {
"type": {
"type": "string",
"description": "Transformer type"
},
"config": {
"type": "object",
"description": "Transformer config"
}
},
"required": [
"type"
],
"additionalProperties": false
}
},
"sink": {
"description": "sink",
"anyOf": [
{
"$ref": "#/definitions/datahub_kafka_sink"
},
{
"$ref": "#/definitions/datahub_rest_sink"
},
{
"$ref": "#/definitions/console_sink"
},
{
"$ref": "#/definitions/file_sink"
}
]
}
},
"required": [
"source"
]
} | datahub_ingestion_schema |
{
"type": "object",
"properties": {
"PayloadUUID": {
"default": "",
"pattern": "^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$",
"type": "string",
"description": "Unique identifier for the payload (format 01234567-89AB-CDEF-0123-456789ABCDEF)"
},
"ServerCapabilities": {
"enum": [
"com.apple.mdm.per-user-connections"
],
"type": "array",
"description": "Optional. An array of strings indicating server capabilities. If the server manages OS X devices or a shared iPad, this field is mandatory and must contain the value com.apple.mdm.per-user-connections. This indicates that the server supports both device and user connections."
},
"PayloadDescription": {
"default": "Configures a Mobile Device Management server",
"type": "string",
"description": "Description of the payload"
},
"CheckInURL": {
"pattern": "^https://.*$",
"type": "string",
"description": "The URL that the device will use to check in during installation. If this URL is not given, the ServerURL will be used for both purposes."
},
"CheckOutWhenRemoved": {
"type": "boolean",
"description": "If true, the device attempts to send a CheckOut message to the check-in server when the profile is removed. Defaults to false.\n\t\t\t\tNote: OS X v10.8 acts as though this setting is always true."
},
"PayloadOrganization": {
"type": "string",
"description": "This value describes the issuing organization of the profile, as displayed to the user"
},
"ServerURL": {
"pattern": "^https://.*$",
"type": "string",
"description": "The URL that the device will contact to retrieve device management instructions."
},
"PayloadIdentifier": {
"default": "com.apple.mdm",
"type": "string",
"description": "A unique identifier for the payload, dot-delimited. Usually root PayloadIdentifier+subidentifier"
},
"PayloadDisplayName": {
"default": "MDM",
"type": "string",
"description": "Name of the payload"
},
"Topic": {
"type": "string",
"description": "The topic that MDM will listen to for Push notifications. The certificate that the server uses to send push notifications must have the same topic in its subject."
},
"PayloadType": {
"default": "com.apple.mdm",
"type": "string",
"description": "The type of the payload, a reverse dns string"
},
"SignMessage": {
"default": false,
"type": "boolean",
"description": "If set, each message coming from the device will carry the additional HTTP header Mdm-Signature"
},
"PayloadVersion": {
"default": 1,
"type": "number",
"description": "The version of the whole configuration profile."
},
"IdentityCertificateUUID": {
"pattern": "^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$",
"type": "string",
"description": "UUID of the certificate payload for the device's identity. It may also point to a SCEP payload."
},
"AccessRights": {
"type": "number",
"description": "Logical OR of several bit-flags. If 2 is specified, then 1 must also be specified. If 128 is specified, then 64 must also be specified."
},
"UseDevelopmentAPNS": {
"default": false,
"type": "boolean",
"description": "If set, will use the development APNS servers. Otherwise, the device will use the production servers."
}
},
"title": "com.apple.mdm"
}
| o61619 |
{
"properties": {
"annotationPrefix": {
"description": "The prefix for HTTP annotations in Thrift files",
"examples": [
"zanzibar"
],
"type": "string"
},
"clientConfig": {
"description": "The directory for client module configs, relative to application root directory",
"examples": [
"./clients"
],
"type": "string"
},
"copyrightHeader": {
"description": "The path of copyright header file, relative to application root directory",
"examples": [
"./copyright_header.txt"
],
"type": "string"
},
"endpointConfig": {
"description": "The directory for endpoint module configs, relative to application root directory",
"examples": [
"./endpoints"
],
"type": "string"
},
"genCodePackage": {
"description": "The package path for thriftrw and easyjson generated structs and (de)serializers",
"examples": [
"github.com/uber/zanzibar/examples/example-gateway/build/gen-code"
],
"type": "string"
},
"genMock": {
"description": "Whether to generate mocks during code generation",
"examples": [
true
],
"type": "boolean"
},
"middlewareConfig": {
"description": "The directory for middleware module configs, relative to application root directory",
"examples": [
"./middlewares"
],
"type": "string"
},
"packageRoot": {
"description": "The application package root",
"examples": [
"github.com/uber/zanzibar/examples/example-gateway"
],
"type": "string"
},
"targetGenDir": {
"description": "An explanation about the purpose of this instance.",
"examples": [
"./build"
],
"type": "string"
},
"thriftRootDir": {
"description": "The path of idl directory, relative to application root directory",
"examples": [
"./idl"
],
"type": "string"
},
"traceKey": {
"description": "The name of the generated trace header",
"examples": [
"x-trace-id"
],
"type": "string"
}
},
"required": [
"packageRoot",
"thriftRootDir",
"genCodePackage",
"targetGenDir",
"middlewareConfig",
"copyrightHeader",
"annotationPrefix",
"traceKey",
"genMock"
],
"type": "object"
} | o83289 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"start": {
"type": "string"
},
"end": {
"type": "string"
},
"active": {
"type": "boolean"
},
"divisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"flags": {
"type": "array",
"items": {
"type": "string"
}
},
"large_icon": {
"type": "string"
},
"small_icon": {
"type": "string"
},
"pip_icon": {
"type": "string"
},
"tiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"points": {
"type": "number"
}
},
"required": [
"points"
]
}
}
},
"required": [
"name",
"flags",
"large_icon",
"small_icon",
"pip_icon",
"tiers"
]
}
},
"leaderboards": {
"type": "object",
"properties": {
"legendary": {
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"duration": {
"type": "null"
},
"scoring": {
"type": "string"
},
"tiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"range": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"range"
]
}
}
}
},
"scorings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"ordering": {
"type": "string"
}
}
}
}
}
},
"guild": {
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"duration": {
"type": "null"
},
"scoring": {
"type": "string"
},
"tiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"range": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"color",
"type",
"name",
"range"
]
}
}
}
},
"scorings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"ordering": {
"type": "string"
}
},
"required": [
"id",
"type",
"description",
"name",
"ordering"
]
}
}
}
}
}
},
"ranks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"overlay": {
"type": "string"
},
"overlay_small": {
"type": "string"
},
"tiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rating": {
"type": "number"
}
},
"required": [
"rating"
]
}
}
},
"required": [
"name",
"description",
"icon",
"overlay",
"overlay_small",
"tiers"
]
}
}
},
"required": [
"id",
"name",
"start",
"end",
"active",
"divisions",
"leaderboards"
]
},
"properties": {},
"additionalProperties": false
} | o45201 |
{
"properties": {
"dimensions": {
"properties": {
"length": {
"description": "The length of the shape",
"type": "number"
},
"radius": {
"description": "The radius of the shape",
"type": "number"
},
"width": {
"description": "The width of the shape",
"type": "number"
}
},
"required": [
"length",
"width",
"radius"
],
"type": "object"
},
"shape": {
"description": "The type of shape (e.g. square, rectangle, circle)",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_d8d800a1 |
{
"properties": {
"dimensions": {
"description": "The dimensions of the shape",
"properties": {
"base": {
"description": "The base of the triangle",
"type": "number"
},
"height": {
"description": "The height of the triangle",
"type": "number"
},
"length": {
"description": "The length of the rectangle",
"type": "number"
},
"radius": {
"description": "The radius of the circle",
"type": "number"
},
"width": {
"description": "The width of the rectangle",
"type": "number"
}
},
"required": [
"radius",
"length",
"width",
"base",
"height"
],
"type": "object"
},
"shape": {
"description": "The geometric shape",
"enum": [
"circle",
"rectangle",
"triangle"
],
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_b4863a84 |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_batch_v1_JobSpec": {
"description": "JobSpec describes how the job execution will look like.",
"properties": {
"activeDeadlineSeconds": {
"_format": "int64",
"description": "Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer",
"type": "integer"
},
"backoffLimit": {
"_format": "int32",
"description": "Specifies the number of retries before marking this job failed. Defaults to 6",
"type": "integer"
},
"completions": {
"_format": "int32",
"description": "Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/",
"type": "integer"
},
"manualSelector": {
"description": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector",
"type": "boolean"
},
"parallelism": {
"_format": "int32",
"description": "Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/",
"type": "integer"
},
"selector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors"
},
"template": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodTemplateSpec",
"description": "Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/"
},
"ttlSecondsAfterFinished": {
"_format": "int32",
"description": "ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.",
"type": "integer"
}
},
"required": [
"template"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AWSElasticBlockStoreVolumeSource": {
"description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
},
"partition": {
"_format": "int32",
"description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).",
"type": "integer"
},
"readOnly": {
"description": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\". If omitted, the default is \"false\". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "boolean"
},
"volumeID": {
"description": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Affinity": {
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAntiAffinity",
"description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureDiskVolumeSource": {
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"properties": {
"cachingMode": {
"description": "Host Caching mode: None, Read Only, Read Write.",
"type": "string"
},
"diskName": {
"description": "The Name of the data disk in the blob storage",
"type": "string"
},
"diskURI": {
"description": "The URI the data disk in the blob storage",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"kind": {
"description": "Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureFileVolumeSource": {
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.",
"properties": {
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretName": {
"description": "the name of secret that contains Azure Storage Account Name and Key",
"type": "string"
},
"shareName": {
"description": "Share Name",
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CSIVolumeSource": {
"description": "Represents a source location of a volume to mount, managed by an external CSI driver",
"properties": {
"driver": {
"description": "Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.",
"type": "string"
},
"nodePublishSecretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed."
},
"readOnly": {
"description": "Specifies a read-only configuration for the volume. Defaults to false (read/write).",
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"description": "VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.",
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Capabilities": {
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CephFSVolumeSource": {
"description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"monitors": {
"description": "Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /",
"type": "string"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "boolean"
},
"secretFile": {
"description": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"
},
"user": {
"description": "Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CinderVolumeSource": {
"description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: points to a secret object containing parameters used to connect to OpenStack."
},
"volumeID": {
"description": "volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapEnvSource": {
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapKeySelector": {
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapProjection": {
"description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.",
"properties": {
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapVolumeSource": {
"description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext",
"description": "Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort": {
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"_format": "int32",
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"_format": "int32",
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIProjection": {
"description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.",
"properties": {
"items": {
"description": "Items is a list of DownwardAPIVolume file",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector",
"description": "Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."
},
"mode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeSource": {
"description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "Items is a list of downward API volume file",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EmptyDirVolumeSource": {
"description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.",
"properties": {
"medium": {
"description": "What type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir",
"type": "string"
},
"sizeLimit": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity",
"description": "Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar": {
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVarSource": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EphemeralContainer": {
"description": "An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle",
"description": "Lifecycle is not allowed for ephemeral containers."
},
"livenessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"name": {
"description": "Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.",
"type": "string"
},
"ports": {
"description": "Ports are not allowed for ephemeral containers.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort"
},
"type": "array"
},
"readinessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"resources": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements",
"description": "Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod."
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext",
"description": "SecurityContext is not allowed for ephemeral containers."
},
"startupProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"targetContainerName": {
"description": "If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.",
"type": "string"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction": {
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FCVolumeSource": {
"description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"lun": {
"_format": "int32",
"description": "Optional: FC target lun number",
"type": "integer"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"targetWWNs": {
"description": "Optional: FC target worldwide names (WWNs)",
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"description": "Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlexVolumeSource": {
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.",
"properties": {
"driver": {
"description": "Driver is the name of the driver to use for this volume.",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Extra command options if any.",
"type": "object"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts."
}
},
"required": [
"driver"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlockerVolumeSource": {
"description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.",
"properties": {
"datasetName": {
"description": "Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated",
"type": "string"
},
"datasetUUID": {
"description": "UUID of the dataset. This is unique identifier of a Flocker dataset",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GCEPersistentDiskVolumeSource": {
"description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"partition": {
"_format": "int32",
"description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "integer"
},
"pdName": {
"description": "Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GitRepoVolumeSource": {
"description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.",
"properties": {
"directory": {
"description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.",
"type": "string"
},
"repository": {
"description": "Repository URL",
"type": "string"
},
"revision": {
"description": "Commit hash for the specified revision.",
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GlusterfsVolumeSource": {
"description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"endpoints": {
"description": "EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"path": {
"description": "Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction": {
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPHeader": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler": {
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostAlias": {
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostPathVolumeSource": {
"description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
},
"type": {
"description": "Type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ISCSIVolumeSource": {
"description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.",
"properties": {
"chapAuthDiscovery": {
"description": "whether support iSCSI Discovery CHAP authentication",
"type": "boolean"
},
"chapAuthSession": {
"description": "whether support iSCSI Session CHAP authentication",
"type": "boolean"
},
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi",
"type": "string"
},
"initiatorName": {
"description": "Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.",
"type": "string"
},
"iqn": {
"description": "Target iSCSI Qualified Name.",
"type": "string"
},
"iscsiInterface": {
"description": "iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).",
"type": "string"
},
"lun": {
"_format": "int32",
"description": "iSCSI Target Lun number.",
"type": "integer"
},
"portals": {
"description": "iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "CHAP Secret for iSCSI target and initiator authentication"
},
"targetPortal": {
"description": "iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "The key to project.",
"type": "string"
},
"mode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"path": {
"description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle": {
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NFSVolumeSource": {
"description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "boolean"
},
"server": {
"description": "Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeAffinity": {
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelector": {
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement": {
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "The label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
"type": "string"
},
"values": {
"description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm": {
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector": {
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimVolumeSource": {
"description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).",
"properties": {
"claimName": {
"description": "ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims",
"type": "string"
},
"readOnly": {
"description": "Will force the ReadOnly setting in VolumeMounts. Default false.",
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PhotonPersistentDiskVolumeSource": {
"description": "Represents a Photon Controller persistent disk resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"pdID": {
"description": "ID that identifies Photon Controller persistent disk",
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinity": {
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm": {
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaces": {
"description": "namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAntiAffinity": {
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfig": {
"description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.",
"properties": {
"nameservers": {
"description": "A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.",
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"description": "A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfigOption"
},
"type": "array"
},
"searches": {
"description": "A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfigOption": {
"description": "PodDNSConfigOption defines DNS resolver options of a pod.",
"properties": {
"name": {
"description": "Required.",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodReadinessGate": {
"description": "PodReadinessGate contains the reference to a pod condition",
"properties": {
"conditionType": {
"description": "ConditionType refers to a condition in the pod's condition list with matching type.",
"type": "string"
}
},
"required": [
"conditionType"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSecurityContext": {
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"_format": "int64",
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified defaults to \"Always\".",
"type": "string"
},
"runAsGroup": {
"_format": "int64",
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"_format": "int64",
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"_format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSpec": {
"description": "PodSpec is a description of a pod.",
"properties": {
"activeDeadlineSeconds": {
"_format": "int64",
"description": "Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.",
"type": "integer"
},
"affinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Affinity",
"description": "If specified, the pod's scheduling constraints"
},
"automountServiceAccountToken": {
"description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
"type": "boolean"
},
"containers": {
"description": "List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"dnsConfig": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfig",
"description": "Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy."
},
"dnsPolicy": {
"description": "Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.",
"type": "string"
},
"enableServiceLinks": {
"description": "EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.",
"type": "boolean"
},
"ephemeralContainers": {
"description": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EphemeralContainer"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"hostAliases": {
"description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostAlias"
},
"type": "array",
"x-kubernetes-patch-merge-key": "ip",
"x-kubernetes-patch-strategy": "merge"
},
"hostIPC": {
"description": "Use the host's ipc namespace. Optional: Default to false.",
"type": "boolean"
},
"hostNetwork": {
"description": "Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.",
"type": "boolean"
},
"hostPID": {
"description": "Use the host's pid namespace. Optional: Default to false.",
"type": "boolean"
},
"hostname": {
"description": "Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.",
"type": "string"
},
"imagePullSecrets": {
"description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"initContainers": {
"description": "List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"nodeName": {
"description": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": "object"
},
"overhead": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.",
"type": "object"
},
"preemptionPolicy": {
"description": "PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.",
"type": "string"
},
"priority": {
"_format": "int32",
"description": "The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.",
"type": "integer"
},
"priorityClassName": {
"description": "If specified, indicates the pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.",
"type": "string"
},
"readinessGates": {
"description": "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodReadinessGate"
},
"type": "array"
},
"restartPolicy": {
"description": "Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy",
"type": "string"
},
"runtimeClassName": {
"description": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.",
"type": "string"
},
"schedulerName": {
"description": "If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSecurityContext",
"description": "SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field."
},
"serviceAccount": {
"description": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.",
"type": "string"
},
"serviceAccountName": {
"description": "ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "string"
},
"shareProcessNamespace": {
"description": "Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.",
"type": "boolean"
},
"subdomain": {
"description": "If specified, the fully qualified Pod hostname will be \"<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>\". If not specified, the pod will not have a domainname at all.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"_format": "int64",
"description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.",
"type": "integer"
},
"tolerations": {
"description": "If specified, the pod's tolerations.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TopologySpreadConstraint"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"topologyKey",
"whenUnsatisfiable"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "topologyKey",
"x-kubernetes-patch-strategy": "merge"
},
"volumes": {
"description": "List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Volume"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge,retainKeys"
}
},
"required": [
"containers"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodTemplateSpec": {
"description": "PodTemplateSpec describes the data a pod should have when created from a template",
"properties": {
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSpec",
"description": "Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PortworxVolumeSource": {
"description": "PortworxVolumeSource represents a Portworx volume resource.",
"properties": {
"fsType": {
"description": "FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"volumeID": {
"description": "VolumeID uniquely identifies a Portworx volume",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PreferredSchedulingTerm": {
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"_format": "int32",
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"_format": "int32",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"_format": "int32",
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"type": "integer"
},
"periodSeconds": {
"_format": "int32",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"type": "integer"
},
"successThreshold": {
"_format": "int32",
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"timeoutSeconds": {
"_format": "int32",
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"type": "integer"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ProjectedVolumeSource": {
"description": "Represents a projected volume source",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"sources": {
"description": "list of volume projections",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeProjection"
},
"type": "array"
}
},
"required": [
"sources"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_QuobyteVolumeSource": {
"description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
"properties": {
"group": {
"description": "Group to map volume access to Default is no group",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.",
"type": "boolean"
},
"registry": {
"description": "Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes",
"type": "string"
},
"tenant": {
"description": "Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin",
"type": "string"
},
"user": {
"description": "User to map volume access to Defaults to serivceaccount user",
"type": "string"
},
"volume": {
"description": "Volume is a string that references an already created Quobyte volume by name.",
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_RBDVolumeSource": {
"description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd",
"type": "string"
},
"image": {
"description": "The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"keyring": {
"description": "Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"monitors": {
"description": "A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"description": "The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
},
"user": {
"description": "The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector": {
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ScaleIOVolumeSource": {
"description": "ScaleIOVolumeSource represents a persistent ScaleIO volume",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\".",
"type": "string"
},
"gateway": {
"description": "The host address of the ScaleIO API Gateway.",
"type": "string"
},
"protectionDomain": {
"description": "The name of the ScaleIO Protection Domain for the configured storage.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail."
},
"sslEnabled": {
"description": "Flag to enable/disable SSL communication with Gateway, default false",
"type": "boolean"
},
"storageMode": {
"description": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.",
"type": "string"
},
"storagePool": {
"description": "The ScaleIO Storage Pool associated with the protection domain.",
"type": "string"
},
"system": {
"description": "The name of the storage system as configured in ScaleIO.",
"type": "string"
},
"volumeName": {
"description": "The name of a volume already created in the ScaleIO system that is associated with this volume source.",
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretEnvSource": {
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretKeySelector": {
"description": "SecretKeySelector selects a key of a Secret.",
"properties": {
"key": {
"description": "The key of the secret to select from. Must be a valid secret key.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretProjection": {
"description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.",
"properties": {
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretVolumeSource": {
"description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"optional": {
"description": "Specify whether the Secret or its keys must be defined",
"type": "boolean"
},
"secretName": {
"description": "Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"_format": "int64",
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"_format": "int64",
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"windowsOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ServiceAccountTokenProjection": {
"description": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).",
"properties": {
"audience": {
"description": "Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.",
"type": "string"
},
"expirationSeconds": {
"_format": "int64",
"description": "ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.",
"type": "integer"
},
"path": {
"description": "Path is the path relative to the mount point of the file to project the token into.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_StorageOSVolumeSource": {
"description": "Represents a StorageOS persistent volume resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted."
},
"volumeName": {
"description": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.",
"type": "string"
},
"volumeNamespace": {
"description": "VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Sysctl": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction": {
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Toleration": {
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"_format": "int64",
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TopologySpreadConstraint": {
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"_format": "int32",
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. It's the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. It's a required field. Default value is 1 and 0 is not allowed.",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as \"Unsatisfiable\" if and only if placing incoming pod on any topology violates \"MaxSkew\". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Volume": {
"description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.",
"properties": {
"awsElasticBlockStore": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AWSElasticBlockStoreVolumeSource",
"description": "AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"
},
"azureDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureDiskVolumeSource",
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."
},
"azureFile": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureFileVolumeSource",
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod."
},
"cephfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CephFSVolumeSource",
"description": "CephFS represents a Ceph FS mount on the host that shares a pod's lifetime"
},
"cinder": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CinderVolumeSource",
"description": "Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"
},
"configMap": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapVolumeSource",
"description": "ConfigMap represents a configMap that should populate this volume"
},
"csi": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CSIVolumeSource",
"description": "CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature)."
},
"downwardAPI": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeSource",
"description": "DownwardAPI represents downward API about the pod that should populate this volume"
},
"emptyDir": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EmptyDirVolumeSource",
"description": "EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"
},
"fc": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FCVolumeSource",
"description": "FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod."
},
"flexVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlexVolumeSource",
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin."
},
"flocker": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlockerVolumeSource",
"description": "Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running"
},
"gcePersistentDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GCEPersistentDiskVolumeSource",
"description": "GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"
},
"gitRepo": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GitRepoVolumeSource",
"description": "GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container."
},
"glusterfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GlusterfsVolumeSource",
"description": "Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md"
},
"hostPath": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostPathVolumeSource",
"description": "HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"
},
"iscsi": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ISCSIVolumeSource",
"description": "ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md"
},
"name": {
"description": "Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"nfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NFSVolumeSource",
"description": "NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"
},
"persistentVolumeClaim": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimVolumeSource",
"description": "PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
},
"photonPersistentDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PhotonPersistentDiskVolumeSource",
"description": "PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"
},
"portworxVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PortworxVolumeSource",
"description": "PortworxVolume represents a portworx volume attached and mounted on kubelets host machine"
},
"projected": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ProjectedVolumeSource",
"description": "Items for all in one resources secrets, configmaps, and downward API"
},
"quobyte": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_QuobyteVolumeSource",
"description": "Quobyte represents a Quobyte mount on the host that shares a pod's lifetime"
},
"rbd": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_RBDVolumeSource",
"description": "RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md"
},
"scaleIO": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ScaleIOVolumeSource",
"description": "ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."
},
"secret": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretVolumeSource",
"description": "Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"
},
"storageos": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_StorageOSVolumeSource",
"description": "StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."
},
"vsphereVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VsphereVirtualDiskVolumeSource",
"description": "VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice": {
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"properties": {
"devicePath": {
"description": "devicePath is the path inside of the container that the device will be mapped to.",
"type": "string"
},
"name": {
"description": "name must match the name of a persistentVolumeClaim in the pod",
"type": "string"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount": {
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeProjection": {
"description": "Projection that may be projected along with other supported volume types",
"properties": {
"configMap": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapProjection",
"description": "information about the configMap data to project"
},
"downwardAPI": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIProjection",
"description": "information about the downwardAPI data to project"
},
"secret": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretProjection",
"description": "information about the secret data to project"
},
"serviceAccountToken": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ServiceAccountTokenProjection",
"description": "information about the serviceAccountToken data to project"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VsphereVirtualDiskVolumeSource": {
"description": "Represents a vSphere volume resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"storagePolicyID": {
"description": "Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.",
"type": "string"
},
"storagePolicyName": {
"description": "Storage Policy Based Management (SPBM) profile name.",
"type": "string"
},
"volumePath": {
"description": "Path that identifies vSphere volume vmdk",
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm": {
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"_format": "int32",
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector": {
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelectorRequirement": {
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1",
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type."
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"time": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": "object"
},
"clusterName": {
"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
"type": "string"
},
"creationTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"deletionGracePeriodSeconds": {
"_format": "int64",
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"_format": "int64",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "JobTemplateSpec describes the data a Job should have when created from a template",
"properties": {
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_batch_v1_JobSpec",
"description": "Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
}
},
"type": "object"
} | kb_490_Normalized |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"users",
"releases",
"companies",
"repos",
"project_types"
],
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"launchpad_id": {
"type": "string",
"pattern": "^[a-z\\d\\.-]+$"
},
"gerrit_id": {
"type": "string"
},
"user_name": {
"type": "string"
},
"emails": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z\\d_\\.-]+@([a-z\\d\\.-]+\\.)+[a-z]+$"
},
"minItems": 1
},
"companies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"company_name": {
"type": "string"
},
"end_date": {
"type": [
"string",
"null"
],
"pattern": "^20\\d{2}-\\w{3}-[0-3]\\d$"
}
},
"required": [
"company_name",
"end_date"
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": [
"launchpad_id",
"user_name",
"emails"
],
"additionalProperties": false
}
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"release_name": {
"type": "string"
},
"end_date": {
"type": "string",
"pattern": "^20\\d{2}-\\w{3}-[0-3]\\d$"
}
},
"required": [
"release_name",
"end_date"
],
"additionalProperties": false
}
},
"repos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string"
},
"organization": {
"type": "string"
},
"module": {
"type": "string"
},
"releases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"branch": {
"type": "string"
},
"tag_from": {
"type": "string"
},
"tag_to": {
"type": "string"
},
"release_name": {
"type": "string"
}
},
"required": [
"tag_from",
"tag_to",
"release_name"
]
}
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"uri",
"module",
"organization"
],
"additionalProperties": false
}
},
"companies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"company_name": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z\\d\\.-]*$"
}
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"company_name",
"domains"
],
"additionalProperties": false
}
},
"project_sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organization": {
"type": "string"
},
"module_group_name": {
"type": "string",
"pattern": "^[\\w-]+$"
},
"exclude": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"organization"
],
"additionalProperties": false
}
},
"module_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"module_group_name": {
"type": "string",
"pattern": "^[\\w-]+$"
},
"modules": {
"type": [
"array"
],
"items": {
"type": "string"
}
}
},
"required": [
"module_group_name",
"modules"
],
"additionalProperties": false
}
},
"mail_lists": {
"type": "array",
"items": {
"type": "string"
}
},
"member_lists": {
"type": "array",
"items": {
"type": "string"
}
},
"voting_date": {
"type": "string"
},
"project_types": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[\\w-]+$"
},
"child": {
"type": "boolean"
},
"title": {
"type": "string"
},
"modules": {
"type": [
"array"
],
"items": {
"type": "string",
"pattern": "^[\\w-]+$"
}
}
},
"required": [
"id",
"title",
"modules"
],
"additionalProperties": false
}
}
}
} | o84327 |
{
"properties": {
"dimensions": {
"properties": {
"base": {
"description": "The base of a triangle",
"type": "number"
},
"height": {
"description": "The height of a triangle",
"type": "number"
},
"length": {
"description": "The length of a rectangle",
"type": "number"
},
"radius": {
"description": "The radius of a circle",
"type": "number"
},
"width": {
"description": "The width of a rectangle",
"type": "number"
}
},
"type": "object"
},
"shape": {
"description": "The geometric shape (e.g. circle, rectangle, triangle)",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_cbf811fb |
{
"Transaction": {
"properties": {
"date": {
"_format": "date-time",
"type": "string"
},
"nonce": {
"type": "integer"
},
"recipient": {
"type": "string"
},
"source": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"recipient",
"source",
"date",
"value",
"nonce"
],
"type": "object"
},
"properties": {
"address": {
"type": "string"
},
"balance": {
"type": "integer"
},
"bonus-credit": {
"type": "integer"
},
"created": {
"_format": "date-time",
"type": "string"
},
"identity": {
"type": "object"
},
"ranking": {
"type": "integer"
},
"scheme": {
"constant": "walletData"
},
"status": {
"enum": [
"active",
"deleted"
]
},
"transactions": {
"items": {
"$ref": "#/Transaction"
},
"type": "array"
}
},
"required": [
"scheme",
"address",
"status",
"identity",
"created",
"balance",
"ranking",
"bonus-credit",
"transactions"
],
"type": "object"
} | o69729 |
{
"properties": {
"check-in_date": {
"description": "The check-in date for the hotel",
"type": "string"
},
"check-out_date": {
"description": "The check-out date for the hotel",
"type": "string"
},
"location": {
"description": "The location to search for hotels",
"type": "string"
},
"num_guests": {
"description": "The number of guests staying at the hotel",
"type": "integer"
}
},
"required": [
"location",
"check-in_date",
"check-out_date",
"num_guests"
],
"type": "object"
} | search_hotels_c8d642e8 |
{
"properties": {
"dimensions": {
"description": "The dimensions of the shape",
"properties": {
"base": {
"description": "The base of the shape",
"type": "number"
},
"height": {
"description": "The height of the shape",
"type": "number"
},
"length": {
"description": "The length of the shape",
"type": "number"
},
"radius": {
"description": "The radius of the shape",
"type": "number"
},
"width": {
"description": "The width of the shape",
"type": "number"
}
},
"required": [
"length",
"width",
"radius",
"base",
"height"
],
"type": "object"
},
"shape": {
"description": "The type of shape (e.g. circle, rectangle, triangle)",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_dc80fc0f |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
}
},
"description": "FlowSchemaCondition describes conditions for a FlowSchema.",
"properties": {
"lastTransitionTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "`lastTransitionTime` is the last time the condition transitioned from one status to another."
},
"message": {
"description": "`message` is a human-readable message indicating details about last transition.",
"type": [
"string",
"null"
]
},
"reason": {
"description": "`reason` is a unique, one-word, CamelCase reason for the condition's last transition.",
"type": [
"string",
"null"
]
},
"status": {
"description": "`status` is the status of the condition. Can be True, False, Unknown. Required.",
"type": [
"string",
"null"
]
},
"type": {
"description": "`type` is the type of the condition. Required.",
"type": [
"string",
"null"
]
}
},
"type": "object"
} | kb_364_Normalized |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_oai": {
"type": "object",
"properties": {
"updated": {
"type": "string"
},
"id": {
"type": "string"
},
"sets": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"updated",
"id"
]
}
}
} | o48006 |
{
"additionalProperties": false,
"properties": {
"pulse": {
"type": "boolean"
},
"resourceLimits": {
"type": "boolean"
},
"vmLogs": {
"type": "boolean"
},
"webShell": {
"type": "boolean"
}
},
"type": "object"
} | o27835 |
{
"oneOf": [
{
"$ref": "#/definitions/ExtendedUnitSpec",
"description": "Schema for a unit Vega-Lite specification, with the syntactic sugar extensions:\n\n- `row` and `column` are included in the encoding.\n\n- (Future) label, box plot\n\n\n\nNote: the spec could contain facet."
},
{
"$ref": "#/definitions/FacetSpec"
},
{
"$ref": "#/definitions/LayerSpec"
}
],
"definitions": {
"ExtendedUnitSpec": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"mark": {
"$ref": "#/definitions/Mark",
"description": "The mark type.\n\nOne of `\"bar\"`, `\"circle\"`, `\"square\"`, `\"tick\"`, `\"line\"`,\n\n`\"area\"`, `\"point\"`, `\"rule\"`, and `\"text\"`."
},
"encoding": {
"$ref": "#/definitions/Encoding",
"description": "A key-value mapping between encoding channels and definition of fields."
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"description": {
"description": "An optional description of this mark for commenting purpose.\n\nThis property has no effect on the output visualization.",
"type": "string"
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"transform": {
"$ref": "#/definitions/Transform",
"description": "An object describing filter and new field calculation."
},
"config": {
"$ref": "#/definitions/Config",
"description": "Configuration object"
}
},
"required": [
"mark"
]
},
"Mark": {
"type": "string",
"enum": [
"area",
"bar",
"line",
"point",
"text",
"tick",
"rule",
"circle",
"square",
"errorBar"
]
},
"Encoding": {
"type": "object",
"properties": {
"row": {
"$ref": "#/definitions/PositionChannelDef",
"description": "Vertical facets for trellis plots."
},
"column": {
"$ref": "#/definitions/PositionChannelDef",
"description": "Horizontal facets for trellis plots."
},
"x": {
"$ref": "#/definitions/PositionChannelDef",
"description": "X coordinates for `point`, `circle`, `square`,\n\n`line`, `rule`, `text`, and `tick`\n\n(or to width and height for `bar` and `area` marks)."
},
"y": {
"$ref": "#/definitions/PositionChannelDef",
"description": "Y coordinates for `point`, `circle`, `square`,\n\n`line`, `rule`, `text`, and `tick`\n\n(or to width and height for `bar` and `area` marks)."
},
"x2": {
"$ref": "#/definitions/FieldDef",
"description": "X2 coordinates for ranged `bar`, `rule`, `area`"
},
"y2": {
"$ref": "#/definitions/FieldDef",
"description": "Y2 coordinates for ranged `bar`, `rule`, `area`"
},
"color": {
"$ref": "#/definitions/ChannelDefWithLegend",
"description": "Color of the marks \u2013 either fill or stroke color based on mark type.\n\n(By default, fill color for `area`, `bar`, `tick`, `text`, `circle`, and `square` /\n\nstroke color for `line` and `point`.)"
},
"opacity": {
"$ref": "#/definitions/ChannelDefWithLegend",
"description": "Opacity of the marks \u2013 either can be a value or in a range."
},
"size": {
"$ref": "#/definitions/ChannelDefWithLegend",
"description": "Size of the mark.\n\n- For `point`, `square` and `circle`\n\n\u2013 the symbol size, or pixel area of the mark.\n\n- For `bar` and `tick` \u2013 the bar and tick's size.\n\n- For `text` \u2013 the text's font size.\n\n- Size is currently unsupported for `line` and `area`."
},
"shape": {
"$ref": "#/definitions/ChannelDefWithLegend",
"description": "The symbol's shape (only for `point` marks). The supported values are\n\n`\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`,\n\nor `\"triangle-down\"`, or else a custom SVG path string."
},
"detail": {
"description": "Additional levels of detail for grouping data in aggregate views and\n\nin line and area marks without mapping data to a specific visual channel.",
"oneOf": [
{
"$ref": "#/definitions/FieldDef",
"description": "Interface for any kind of FieldDef;\n\nFor simplicity, we do not declare multiple interfaces of FieldDef like\n\nwe do for JSON schema."
},
{
"type": "array",
"items": {
"$ref": "#/definitions/FieldDef",
"description": "Interface for any kind of FieldDef;\n\nFor simplicity, we do not declare multiple interfaces of FieldDef like\n\nwe do for JSON schema."
}
}
]
},
"text": {
"$ref": "#/definitions/FieldDef",
"description": "Text of the `text` mark."
},
"label": {
"$ref": "#/definitions/FieldDef"
},
"path": {
"description": "Order of data points in line marks.",
"oneOf": [
{
"$ref": "#/definitions/OrderChannelDef"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/OrderChannelDef"
}
}
]
},
"order": {
"description": "Layer order for non-stacked marks, or stack order for stacked marks.",
"oneOf": [
{
"$ref": "#/definitions/OrderChannelDef"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/OrderChannelDef"
}
}
]
}
}
},
"PositionChannelDef": {
"type": "object",
"properties": {
"axis": {
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Axis"
}
]
},
"scale": {
"$ref": "#/definitions/Scale"
},
"sort": {
"oneOf": [
{
"$ref": "#/definitions/SortField"
},
{
"$ref": "#/definitions/SortOrder"
}
]
},
"field": {
"description": "Name of the field from which to pull a data value.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement. This can be either a full type\n\nname (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, and `\"nominal\"`)\n\nor an initial character of the type name (`\"Q\"`, `\"T\"`, `\"O\"`, `\"N\"`).\n\nThis property is case insensitive."
},
"value": {
"description": "A constant value in visual domain.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit for a `temporal` field (e.g., `year`, `yearmonth`, `month`, `hour`)."
},
"bin": {
"description": "Flag for binning a `quantitative` field, or a bin property object\n\nfor binning parameters.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Bin",
"description": "Binning properties or boolean flag for determining whether to bin data or not."
}
]
},
"aggregate": {
"$ref": "#/definitions/AggregateOp",
"description": "Aggregation function for the field\n\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`)."
},
"title": {
"description": "Title for axis or legend.",
"type": "string"
}
}
},
"Axis": {
"type": "object",
"properties": {
"labelAngle": {
"description": "The rotation angle of the axis labels.",
"type": "number"
},
"format": {
"description": "The formatting pattern for axis labels.",
"type": "string"
},
"orient": {
"$ref": "#/definitions/AxisOrient",
"description": "The orientation of the axis. One of top, bottom, left or right. The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart)."
},
"title": {
"description": "A title for the axis. Shows field name and its function by default.",
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "number"
}
},
"axisWidth": {
"description": "Width of the axis line",
"type": "number"
},
"layer": {
"description": "A string indicating if the axis (and any gridlines) should be placed above or below the data marks.",
"type": "string"
},
"offset": {
"description": "The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.",
"type": "number"
},
"axisColor": {
"description": "Color of axis line.",
"type": "string"
},
"grid": {
"description": "A flag indicate if gridlines should be created in addition to ticks. If `grid` is unspecified, the default value is `true` for ROW and COL. For X and Y, the default value is `true` for quantitative and time fields and `false` otherwise.",
"type": "boolean"
},
"gridColor": {
"description": "Color of gridlines.",
"type": "string"
},
"gridDash": {
"description": "The offset (in pixels) into which to begin drawing with the grid dash array.",
"type": "array",
"items": {
"type": "number"
}
},
"gridOpacity": {
"description": "The stroke opacity of grid (value between [0,1])",
"type": "number"
},
"gridWidth": {
"description": "The grid width, in pixels.",
"type": "number"
},
"labels": {
"description": "Enable or disable labels.",
"type": "boolean"
},
"labelAlign": {
"description": "Text alignment for the Label.",
"type": "string"
},
"labelBaseline": {
"description": "Text baseline for the label.",
"type": "string"
},
"labelMaxLength": {
"description": "Truncate labels that are too long.",
"minimum": 1,
"type": "number"
},
"shortTimeLabels": {
"description": "Whether month and day names should be abbreviated.",
"type": "boolean"
},
"subdivide": {
"description": "If provided, sets the number of minor ticks between major ticks (the value 9 results in decimal subdivision). Only applicable for axes visualizing quantitative scales.",
"type": "number"
},
"ticks": {
"description": "A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are \"nice\" (multiples of 2, 5, 10) and lie within the underlying scale's range.",
"minimum": 0,
"type": "number"
},
"tickColor": {
"description": "The color of the axis's tick.",
"type": "string"
},
"tickLabelColor": {
"description": "The color of the tick label, can be in hex color code or regular color name.",
"type": "string"
},
"tickLabelFont": {
"description": "The font of the tick label.",
"type": "string"
},
"tickLabelFontSize": {
"description": "The font size of label, in pixels.",
"type": "number"
},
"tickPadding": {
"description": "The padding, in pixels, between ticks and text labels.",
"type": "number"
},
"tickSize": {
"description": "The size, in pixels, of major, minor and end ticks.",
"minimum": 0,
"type": "number"
},
"tickSizeMajor": {
"description": "The size, in pixels, of major ticks.",
"minimum": 0,
"type": "number"
},
"tickSizeMinor": {
"description": "The size, in pixels, of minor ticks.",
"minimum": 0,
"type": "number"
},
"tickSizeEnd": {
"description": "The size, in pixels, of end ticks.",
"minimum": 0,
"type": "number"
},
"tickWidth": {
"description": "The width, in pixels, of ticks.",
"type": "number"
},
"titleColor": {
"description": "Color of the title, can be in hex color code or regular color name.",
"type": "string"
},
"titleFont": {
"description": "Font of the title.",
"type": "string"
},
"titleFontSize": {
"description": "Size of the title.",
"type": "number"
},
"titleFontWeight": {
"description": "Weight of the title.",
"type": "string"
},
"titleOffset": {
"description": "A title offset value for the axis.",
"type": "number"
},
"titleMaxLength": {
"description": "Max length for axis title if the title is automatically generated from the field's description. By default, this is automatically based on cell size and characterWidth property.",
"minimum": 0,
"type": "number"
},
"characterWidth": {
"description": "Character width for automatically determining title max length.",
"type": "number"
},
"properties": {
"description": "Optional mark property definitions for custom axis styling."
}
}
},
"AxisOrient": {
"type": "string",
"enum": [
"top",
"right",
"left",
"bottom"
]
},
"Scale": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/ScaleType"
},
"domain": {
"description": "The domain of the scale, representing the set of data values. For quantitative data, this can take the form of a two-element array with minimum and maximum values. For ordinal/categorical data, this may be an array of valid input values.",
"oneOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"range": {
"description": "The range of the scale, representing the set of visual values. For numeric values, the range can take the form of a two-element array with minimum and maximum values. For ordinal or quantized data, the range may by an array of desired output values, which are mapped to elements in the specified domain. For ordinal scales only, the range can be defined using a DataRef: the range values are then drawn dynamically from a backing data set.",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"round": {
"description": "If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.",
"type": "boolean"
},
"bandSize": {
"minimum": 0,
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/BandSize"
}
]
},
"padding": {
"description": "Applies spacing among ordinal elements in the scale range. The actual effect depends on how the scale is configured. If the __points__ parameter is `true`, the padding value is interpreted as a multiple of the spacing between points. A reasonable value is 1.0, such that the first and last point will be offset from the minimum and maximum value by half the distance between points. Otherwise, padding is typically in the range [0, 1] and corresponds to the fraction of space in the range interval to allocate to padding. A value of 0.5 means that the range band width will be equal to the padding width. For more, see the [D3 ordinal scale documentation](https://github.com/mbostock/d3/wiki/Ordinal-Scales).",
"type": "number"
},
"clamp": {
"description": "If true, values that exceed the data domain are clamped to either the minimum or maximum range value",
"type": "boolean"
},
"nice": {
"description": "If specified, modifies the scale domain to use a more human-friendly value range. If specified as a true boolean, modifies the scale domain to use a more human-friendly number range (e.g., 7 instead of 6.96). If specified as a string, modifies the scale domain to use a more human-friendly value range. For time and utc scale types only, the nice value should be a string indicating the desired time interval.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/NiceTime"
}
]
},
"exponent": {
"description": "Sets the exponent of the scale transformation. For pow scale types only, otherwise ignored.",
"type": "number"
},
"zero": {
"description": "If `true`, ensures that a zero baseline value is included in the scale domain.\n\nDefault value: `true` for `x` and `y` channel if the quantitative field is not binned\n\nand no custom `domain` is provided; `false` otherwise.",
"type": "boolean"
},
"useRawDomain": {
"description": "Uses the source data range as scale domain instead of aggregated data for aggregate axis.\n\nThis property only works with aggregate functions that produce values within the raw data domain (`\"mean\"`, `\"average\"`, `\"stdev\"`, `\"stdevp\"`, `\"median\"`, `\"q1\"`, `\"q3\"`, `\"min\"`, `\"max\"`). For other aggregations that produce values outside of the raw data domain (e.g. `\"count\"`, `\"sum\"`), this property is ignored.",
"type": "boolean"
}
}
},
"ScaleType": {
"type": "string",
"enum": [
"linear",
"log",
"pow",
"sqrt",
"quantile",
"quantize",
"ordinal",
"time",
"utc"
]
},
"BandSize": {
"type": "string",
"enum": [
"fit"
]
},
"NiceTime": {
"type": "string",
"enum": [
"second",
"minute",
"hour",
"day",
"week",
"month",
"year"
]
},
"SortField": {
"type": "object",
"properties": {
"field": {
"description": "The field name to aggregate over.",
"type": "string"
},
"op": {
"$ref": "#/definitions/AggregateOp",
"description": "The sort aggregation operator"
},
"order": {
"$ref": "#/definitions/SortOrder"
}
},
"required": [
"field",
"op"
]
},
"AggregateOp": {
"type": "string",
"enum": [
"values",
"count",
"valid",
"missing",
"distinct",
"sum",
"mean",
"average",
"variance",
"variancep",
"stdev",
"stdevp",
"median",
"q1",
"q3",
"modeskew",
"min",
"max",
"argmin",
"argmax"
]
},
"SortOrder": {
"type": "string",
"enum": [
"ascending",
"descending",
"none"
]
},
"Type": {
"type": "string",
"enum": [
"quantitative",
"ordinal",
"temporal",
"nominal"
]
},
"TimeUnit": {
"type": "string",
"enum": [
"year",
"month",
"day",
"date",
"hours",
"minutes",
"seconds",
"milliseconds",
"yearmonth",
"yearmonthdate",
"yearmonthdatehours",
"yearmonthdatehoursminutes",
"yearmonthdatehoursminutesseconds",
"hoursminutes",
"hoursminutesseconds",
"minutesseconds",
"secondsmilliseconds",
"quarter",
"yearquarter",
"quartermonth",
"yearquartermonth"
]
},
"Bin": {
"type": "object",
"properties": {
"min": {
"description": "The minimum bin value to consider. If unspecified, the minimum value of the specified field is used.",
"type": "number"
},
"max": {
"description": "The maximum bin value to consider. If unspecified, the maximum value of the specified field is used.",
"type": "number"
},
"base": {
"description": "The number base to use for automatic bin determination (default is base 10).",
"type": "number"
},
"step": {
"description": "An exact step size to use between bins. If provided, options such as maxbins will be ignored.",
"type": "number"
},
"steps": {
"description": "An array of allowable step sizes to choose from.",
"type": "array",
"items": {
"type": "number"
}
},
"minstep": {
"description": "A minimum allowable step size (particularly useful for integer values).",
"type": "number"
},
"div": {
"description": "Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.",
"type": "array",
"items": {
"type": "number"
}
},
"maxbins": {
"description": "Maximum number of bins.",
"minimum": 2,
"type": "number"
}
}
},
"FieldDef": {
"type": "object",
"properties": {
"field": {
"description": "Name of the field from which to pull a data value.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement. This can be either a full type\n\nname (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, and `\"nominal\"`)\n\nor an initial character of the type name (`\"Q\"`, `\"T\"`, `\"O\"`, `\"N\"`).\n\nThis property is case insensitive."
},
"value": {
"description": "A constant value in visual domain.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit for a `temporal` field (e.g., `year`, `yearmonth`, `month`, `hour`)."
},
"bin": {
"description": "Flag for binning a `quantitative` field, or a bin property object\n\nfor binning parameters.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Bin",
"description": "Binning properties or boolean flag for determining whether to bin data or not."
}
]
},
"aggregate": {
"$ref": "#/definitions/AggregateOp",
"description": "Aggregation function for the field\n\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`)."
},
"title": {
"description": "Title for axis or legend.",
"type": "string"
}
}
},
"ChannelDefWithLegend": {
"type": "object",
"properties": {
"legend": {
"$ref": "#/definitions/Legend"
},
"scale": {
"$ref": "#/definitions/Scale"
},
"sort": {
"oneOf": [
{
"$ref": "#/definitions/SortField"
},
{
"$ref": "#/definitions/SortOrder"
}
]
},
"field": {
"description": "Name of the field from which to pull a data value.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement. This can be either a full type\n\nname (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, and `\"nominal\"`)\n\nor an initial character of the type name (`\"Q\"`, `\"T\"`, `\"O\"`, `\"N\"`).\n\nThis property is case insensitive."
},
"value": {
"description": "A constant value in visual domain.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit for a `temporal` field (e.g., `year`, `yearmonth`, `month`, `hour`)."
},
"bin": {
"description": "Flag for binning a `quantitative` field, or a bin property object\n\nfor binning parameters.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Bin",
"description": "Binning properties or boolean flag for determining whether to bin data or not."
}
]
},
"aggregate": {
"$ref": "#/definitions/AggregateOp",
"description": "Aggregation function for the field\n\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`)."
},
"title": {
"description": "Title for axis or legend.",
"type": "string"
}
}
},
"Legend": {
"type": "object",
"properties": {
"format": {
"description": "An optional formatting pattern for legend labels. Vega uses D3\\'s format pattern.",
"type": "string"
},
"title": {
"description": "A title for the legend. (Shows field name and its function by default.)",
"type": "string"
},
"values": {
"description": "Explicitly set the visible legend values.",
"type": "array",
"items": {}
},
"orient": {
"description": "The orientation of the legend. One of \"left\" or \"right\". This determines how the legend is positioned within the scene. The default is \"right\".",
"type": "string"
},
"offset": {
"description": "The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.",
"type": "number"
},
"padding": {
"description": "The padding, in pixels, between the lengend and axis.",
"type": "number"
},
"margin": {
"description": "The margin around the legend, in pixels",
"type": "number"
},
"gradientStrokeColor": {
"description": "The color of the gradient stroke, can be in hex color code or regular color name.",
"type": "string"
},
"gradientStrokeWidth": {
"description": "The width of the gradient stroke, in pixels.",
"type": "number"
},
"gradientHeight": {
"description": "The height of the gradient, in pixels.",
"type": "number"
},
"gradientWidth": {
"description": "The width of the gradient, in pixels.",
"type": "number"
},
"labelAlign": {
"description": "The alignment of the legend label, can be left, middle or right.",
"type": "string"
},
"labelBaseline": {
"description": "The position of the baseline of legend label, can be top, middle or bottom.",
"type": "string"
},
"labelColor": {
"description": "The color of the legend label, can be in hex color code or regular color name.",
"type": "string"
},
"labelFont": {
"description": "The font of the lengend label.",
"type": "string"
},
"labelFontSize": {
"description": "The font size of lengend lable.",
"type": "number"
},
"labelOffset": {
"description": "The offset of the legend label.",
"type": "number"
},
"shortTimeLabels": {
"description": "Whether month names and weekday names should be abbreviated.",
"type": "boolean"
},
"symbolColor": {
"description": "The color of the legend symbol,",
"type": "string"
},
"symbolShape": {
"description": "The shape of the legend symbol, can be the 'circle', 'square', 'cross', 'diamond',\n\n'triangle-up', 'triangle-down', or else a custom SVG path string.",
"type": "string"
},
"symbolSize": {
"description": "The size of the lengend symbol, in pixels.",
"type": "number"
},
"symbolStrokeWidth": {
"description": "The width of the symbol's stroke.",
"type": "number"
},
"titleColor": {
"description": "Optional mark property definitions for custom legend styling.\n\nThe color of the legend title, can be in hex color code or regular color name.",
"type": "string"
},
"titleFont": {
"description": "The font of the legend title.",
"type": "string"
},
"titleFontSize": {
"description": "The font size of the legend title.",
"type": "number"
},
"titleFontWeight": {
"description": "The font weight of the legend title.",
"type": "string"
},
"properties": {
"description": "Optional mark property definitions for custom legend styling."
}
}
},
"OrderChannelDef": {
"type": "object",
"properties": {
"sort": {
"$ref": "#/definitions/SortOrder"
},
"field": {
"description": "Name of the field from which to pull a data value.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The encoded field's type of measurement. This can be either a full type\n\nname (`\"quantitative\"`, `\"temporal\"`, `\"ordinal\"`, and `\"nominal\"`)\n\nor an initial character of the type name (`\"Q\"`, `\"T\"`, `\"O\"`, `\"N\"`).\n\nThis property is case insensitive."
},
"value": {
"description": "A constant value in visual domain.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit for a `temporal` field (e.g., `year`, `yearmonth`, `month`, `hour`)."
},
"bin": {
"description": "Flag for binning a `quantitative` field, or a bin property object\n\nfor binning parameters.",
"oneOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/Bin",
"description": "Binning properties or boolean flag for determining whether to bin data or not."
}
]
},
"aggregate": {
"$ref": "#/definitions/AggregateOp",
"description": "Aggregation function for the field\n\n(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`)."
},
"title": {
"description": "Title for axis or legend.",
"type": "string"
}
}
},
"Data": {
"type": "object",
"properties": {
"format": {
"$ref": "#/definitions/DataFormat",
"description": "An object that specifies the format for the data file or values."
},
"url": {
"description": "A URL from which to load the data set. Use the format.type property\n\nto ensure the loaded data is correctly parsed.",
"type": "string"
},
"values": {
"description": "Pass array of objects instead of a url to a file.",
"type": "array",
"items": {}
}
}
},
"DataFormat": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/DataFormatType",
"description": "Type of input data: `\"json\"`, `\"csv\"`, `\"tsv\"`.\n\nThe default format type is determined by the extension of the file url.\n\nIf no extension is detected, `\"json\"` will be used by default."
},
"property": {
"description": "JSON only) The JSON property containing the desired data.\n\nThis parameter can be used when the loaded JSON file may have surrounding structure or meta-data.\n\nFor example `\"property\": \"values.features\"` is equivalent to retrieving `json.values.features`\n\nfrom the loaded JSON object.",
"type": "string"
},
"feature": {
"description": "The name of the TopoJSON object set to convert to a GeoJSON feature collection.\n\nFor example, in a map of the world, there may be an object set named `\"countries\"`.\n\nUsing the feature property, we can extract this set and generate a GeoJSON feature object for each country.",
"type": "string"
},
"mesh": {
"description": "The name of the TopoJSON object set to convert to a mesh.\n\nSimilar to the `feature` option, `mesh` extracts a named TopoJSON object set.\n\nUnlike the `feature` option, the corresponding geo data is returned as a single, unified mesh instance, not as inidividual GeoJSON features.\n\nExtracting a mesh is useful for more efficiently drawing borders or other geographic elements that you do not need to associate with specific regions such as individual countries, states or counties.",
"type": "string"
}
}
},
"DataFormatType": {
"type": "string",
"enum": [
"json",
"csv",
"tsv",
"topojson"
]
},
"Transform": {
"type": "object",
"properties": {
"filter": {
"description": "A string containing the filter Vega expression. Use `datum` to refer to the current data object.",
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/EqualFilter"
},
{
"$ref": "#/definitions/RangeFilter"
},
{
"$ref": "#/definitions/OneOfFilter"
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/definitions/EqualFilter"
},
{
"$ref": "#/definitions/RangeFilter"
},
{
"$ref": "#/definitions/OneOfFilter"
}
]
}
}
]
},
"filterInvalid": {
"description": "Whether to filter invalid values (`null` and `NaN`) from the data. By default (`undefined`), only quantitative and temporal fields are filtered. If set to `true`, all data items with null values are filtered. If `false`, all data items are included.",
"type": "boolean"
},
"calculate": {
"description": "Calculate new field(s) using the provided expresssion(s). Calculation are applied before filter.",
"type": "array",
"items": {
"$ref": "#/definitions/Formula",
"description": "Formula object for calculate."
}
}
}
},
"EqualFilter": {
"type": "object",
"properties": {
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "Time unit for the field to be filtered."
},
"field": {
"description": "Field to be filtered.",
"type": "string"
},
"equal": {
"description": "Value that the field should be equal to.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"$ref": "#/definitions/DateTime",
"description": "Object for defining datetime in Vega-Lite Filter.\n\nIf both month and quarter are provided, month has higher precedence.\n\n`day` cannot be combined with other date.\n\nWe accept string for month and day names."
}
]
}
},
"required": [
"field",
"equal"
]
},
"DateTime": {
"type": "object",
"properties": {
"year": {
"description": "Integer value representing the year.",
"type": "number"
},
"quarter": {
"description": "Integer value representing the quarter of the year (from 1-4).",
"type": "number"
},
"month": {
"description": "One of: (1) integer value representing the month from `1`-`12`. `1` represents January; (2) case-insensitive month name (e.g., `\"January\"`); (3) case-insensitive, 3-character short month name (e.g., `\"Jan\"`).",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"date": {
"description": "Integer value representing the date from 1-31.",
"type": "number"
},
"day": {
"description": "Value representing the day of week. This can be one of: (1) integer value -- `1` represents Monday; (2) case-insensitive day name (e.g., `\"Monday\"`); (3) case-insensitive, 3-character short day name (e.g., `\"Mon\"`). <br/> **Warning:** A DateTime definition object with `day`** should not be combined with `year`, `quarter`, `month`, or `date`.",
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"hours": {
"description": "Integer value representing the hour of day from 0-23.",
"type": "number"
},
"minutes": {
"description": "Integer value representing minute segment of a time from 0-59.",
"type": "number"
},
"seconds": {
"description": "Integer value representing second segment of a time from 0-59.",
"type": "number"
},
"milliseconds": {
"description": "Integer value representing millisecond segment of a time.",
"type": "number"
}
}
},
"RangeFilter": {
"type": "object",
"properties": {
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "time unit for the field to be filtered."
},
"field": {
"description": "Field to be filtered",
"type": "string"
},
"range": {
"description": "Array of inclusive minimum and maximum values\n\nfor a field value of a data item to be included in the filtered data.",
"maxItems": 2,
"minItems": 2,
"type": "array",
"items": {
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/DateTime",
"description": "Object for defining datetime in Vega-Lite Filter.\n\nIf both month and quarter are provided, month has higher precedence.\n\n`day` cannot be combined with other date.\n\nWe accept string for month and day names."
}
]
}
}
},
"required": [
"field",
"range"
]
},
"OneOfFilter": {
"type": "object",
"properties": {
"timeUnit": {
"$ref": "#/definitions/TimeUnit",
"description": "time unit for the field to be filtered."
},
"field": {
"description": "Field to be filtered",
"type": "string"
},
"oneOf": {
"description": "A set of values that the `field`'s value should be a member of,\n\nfor a data item included in the filtered data.",
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"$ref": "#/definitions/DateTime",
"description": "Object for defining datetime in Vega-Lite Filter.\n\nIf both month and quarter are provided, month has higher precedence.\n\n`day` cannot be combined with other date.\n\nWe accept string for month and day names."
}
]
}
}
},
"required": [
"field",
"oneOf"
]
},
"Formula": {
"type": "object",
"properties": {
"field": {
"description": "The field in which to store the computed formula value.",
"type": "string"
},
"expr": {
"description": "A string containing an expression for the formula. Use the variable `datum` to to refer to the current data object.",
"type": "string"
}
},
"required": [
"field",
"expr"
]
},
"Config": {
"type": "object",
"properties": {
"viewport": {
"description": "The width and height of the on-screen viewport, in pixels. If necessary, clipping and scrolling will be applied.",
"type": "number"
},
"background": {
"description": "CSS color property to use as background of visualization. Default is `\"transparent\"`.",
"type": "string"
},
"numberFormat": {
"description": "D3 Number format for axis labels and text tables. For example \"s\" for SI units.",
"type": "string"
},
"timeFormat": {
"description": "Default datetime format for axis and legend labels. The format can be set directly on each axis and legend.",
"type": "string"
},
"countTitle": {
"description": "Default axis and legend title for count fields.",
"type": "string"
},
"cell": {
"$ref": "#/definitions/CellConfig",
"description": "Cell Config"
},
"mark": {
"$ref": "#/definitions/MarkConfig",
"description": "Mark Config"
},
"overlay": {
"$ref": "#/definitions/OverlayConfig",
"description": "Mark Overlay Config"
},
"scale": {
"$ref": "#/definitions/ScaleConfig",
"description": "Scale Config"
},
"axis": {
"$ref": "#/definitions/AxisConfig",
"description": "Axis Config"
},
"legend": {
"$ref": "#/definitions/LegendConfig",
"description": "Legend Config"
},
"facet": {
"$ref": "#/definitions/FacetConfig",
"description": "Facet Config"
}
}
},
"CellConfig": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"clip": {
"type": "boolean"
},
"fill": {
"description": "The fill color.",
"format": "color",
"type": "string"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).",
"type": "number"
},
"stroke": {
"description": "The stroke color.",
"type": "string"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).",
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"type": "number"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"type": "array",
"items": {
"type": "number"
}
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
}
}
},
"MarkConfig": {
"type": "object",
"properties": {
"filled": {
"description": "Whether the shape\\'s color should be used as fill color instead of stroke color.\n\nThis is only applicable for \"bar\", \"point\", and \"area\".\n\nAll marks except \"point\" marks are filled by default.\n\nSee Mark Documentation (http://vega.github.io/vega-lite/docs/marks.html)\n\nfor usage example.",
"type": "boolean"
},
"color": {
"description": "Default color.",
"format": "color",
"type": "string"
},
"fill": {
"description": "Default Fill Color. This has higher precedence than config.color",
"format": "color",
"type": "string"
},
"stroke": {
"description": "Default Stroke Color. This has higher precedence than config.color",
"format": "color",
"type": "string"
},
"opacity": {
"minimum": 0,
"maximum": 1,
"type": "number"
},
"fillOpacity": {
"minimum": 0,
"maximum": 1,
"type": "number"
},
"strokeOpacity": {
"minimum": 0,
"maximum": 1,
"type": "number"
},
"strokeWidth": {
"minimum": 0,
"type": "number"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"type": "array",
"items": {
"type": "number"
}
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"stacked": {
"$ref": "#/definitions/StackOffset"
},
"orient": {
"$ref": "#/definitions/Orient",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\n\nThe value is either horizontal (default) or vertical.\n\n- For bar, rule and tick, this determines whether the size of the bar and tick\n\nshould be applied to x or y dimension.\n\n- For area, this property determines the orient property of the Vega output.\n\n- For line, this property determines the sort order of the points in the line\n\nif `config.sortLineBy` is not specified.\n\nFor stacked charts, this is always determined by the orientation of the stack;\n\ntherefore explicitly specified value will be ignored."
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use. One of linear, step-before, step-after, basis, basis-open, cardinal, cardinal-open, monotone."
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter.",
"type": "number"
},
"lineSize": {
"description": "Size of line mark.",
"type": "number"
},
"ruleSize": {
"description": "Size of rule mark.",
"type": "number"
},
"barSize": {
"description": "The size of the bars. If unspecified, the default size is `bandSize-1`,\n\nwhich provides 1 pixel offset between bars.",
"type": "number"
},
"barThinSize": {
"description": "The size of the bars on continuous scales.",
"type": "number"
},
"shape": {
"description": "The symbol shape to use. One of circle (default), square, cross, diamond, triangle-up, or triangle-down, or a custom SVG path.",
"oneOf": [
{
"$ref": "#/definitions/Shape"
},
{
"type": "string"
}
]
},
"size": {
"description": "The pixel area each the point. For example: in the case of circles, the radius is determined in part by the square root of the size value.",
"type": "number"
},
"tickSize": {
"description": "The width of the ticks.",
"type": "number"
},
"tickThickness": {
"description": "Thickness of the tick mark.",
"type": "number"
},
"align": {
"$ref": "#/definitions/HorizontalAlign",
"description": "The horizontal alignment of the text. One of left, right, center."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"type": "number"
},
"baseline": {
"$ref": "#/definitions/VerticalAlign",
"description": "The vertical alignment of the text. One of top, middle, bottom."
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.",
"type": "number"
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.",
"type": "number"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the x and y properties. Values for theta follow the same convention of arc mark startAngle and endAngle properties: angles are measured in radians, with 0 indicating \"north\".",
"type": "number"
},
"font": {
"description": "The typeface to set the text in (e.g., Helvetica Neue).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., italic)."
},
"fontWeight": {
"$ref": "#/definitions/FontWeight",
"description": "The font weight (e.g., bold)."
},
"format": {
"description": "The formatting pattern for text value. If not defined, this will be determined automatically.",
"type": "string"
},
"shortTimeLabels": {
"description": "Whether month names and weekday names should be abbreviated.",
"type": "boolean"
},
"text": {
"description": "Placeholder Text",
"type": "string"
},
"applyColorToBackground": {
"description": "Apply color field to background color instead of the text.",
"type": "boolean"
}
}
},
"StackOffset": {
"type": "string",
"enum": [
"zero",
"center",
"normalize",
"none"
]
},
"Orient": {
"type": "string",
"enum": [
"horizontal",
"vertical"
]
},
"Interpolate": {
"type": "string",
"enum": [
"linear",
"linear-closed",
"step",
"step-before",
"step-after",
"basis",
"basis-open",
"basis-closed",
"cardinal",
"cardinal-open",
"cardinal-closed",
"bundle",
"monotone"
]
},
"Shape": {
"type": "string",
"enum": [
"circle",
"square",
"cross",
"diamond",
"triangle-up",
"triangle-down"
]
},
"HorizontalAlign": {
"type": "string",
"enum": [
"left",
"right",
"center"
]
},
"VerticalAlign": {
"type": "string",
"enum": [
"top",
"middle",
"bottom"
]
},
"FontStyle": {
"type": "string",
"enum": [
"normal",
"italic"
]
},
"FontWeight": {
"type": "string",
"enum": [
"normal",
"bold"
]
},
"OverlayConfig": {
"type": "object",
"properties": {
"line": {
"description": "Whether to overlay line with point.",
"type": "boolean"
},
"area": {
"$ref": "#/definitions/AreaOverlay",
"description": "Type of overlay for area mark (line or linepoint)"
},
"pointStyle": {
"$ref": "#/definitions/MarkConfig",
"description": "Default style for the overlayed point."
},
"lineStyle": {
"$ref": "#/definitions/MarkConfig",
"description": "Default style for the overlayed point."
}
}
},
"AreaOverlay": {
"type": "string",
"enum": [
"line",
"linepoint",
"none"
]
},
"ScaleConfig": {
"type": "object",
"properties": {
"round": {
"description": "If true, rounds numeric output values to integers.\n\nThis can be helpful for snapping to the pixel grid.\n\n(Only available for `x`, `y`, `size`, `row`, and `column` scales.)",
"type": "boolean"
},
"textBandWidth": {
"description": "Default band width for `x` ordinal scale when is mark is `text`.",
"minimum": 0,
"type": "number"
},
"bandSize": {
"description": "Default band size for (1) `y` ordinal scale,\n\nand (2) `x` ordinal scale when the mark is not `text`.",
"minimum": 0,
"oneOf": [
{
"type": "number"
},
{
"$ref": "#/definitions/BandSize"
}
]
},
"opacity": {
"description": "Default range for opacity.",
"type": "array",
"items": {
"type": "number"
}
},
"padding": {
"description": "Default padding for `x` and `y` ordinal scales.",
"type": "number"
},
"useRawDomain": {
"description": "Uses the source data range as scale domain instead of aggregated data for aggregate axis.\n\nThis property only works with aggregate functions that produce values within the raw data domain (`\"mean\"`, `\"average\"`, `\"stdev\"`, `\"stdevp\"`, `\"median\"`, `\"q1\"`, `\"q3\"`, `\"min\"`, `\"max\"`). For other aggregations that produce values outside of the raw data domain (e.g. `\"count\"`, `\"sum\"`), this property is ignored.",
"type": "boolean"
},
"nominalColorRange": {
"description": "Default range for nominal color scale",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"sequentialColorRange": {
"description": "Default range for ordinal / continuous color scale",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"shapeRange": {
"description": "Default range for shape",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"barSizeRange": {
"description": "Default range for bar size scale",
"type": "array",
"items": {
"type": "number"
}
},
"fontSizeRange": {
"description": "Default range for font size scale",
"type": "array",
"items": {
"type": "number"
}
},
"ruleSizeRange": {
"description": "Default range for rule stroke widths",
"type": "array",
"items": {
"type": "number"
}
},
"tickSizeRange": {
"description": "Default range for tick spans",
"type": "array",
"items": {
"type": "number"
}
},
"pointSizeRange": {
"description": "Default range for bar size scale",
"type": "array",
"items": {
"type": "number"
}
}
}
},
"AxisConfig": {
"type": "object",
"properties": {
"axisWidth": {
"description": "Width of the axis line",
"type": "number"
},
"layer": {
"description": "A string indicating if the axis (and any gridlines) should be placed above or below the data marks.",
"type": "string"
},
"offset": {
"description": "The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.",
"type": "number"
},
"axisColor": {
"description": "Color of axis line.",
"type": "string"
},
"grid": {
"description": "A flag indicate if gridlines should be created in addition to ticks. If `grid` is unspecified, the default value is `true` for ROW and COL. For X and Y, the default value is `true` for quantitative and time fields and `false` otherwise.",
"type": "boolean"
},
"gridColor": {
"description": "Color of gridlines.",
"type": "string"
},
"gridDash": {
"description": "The offset (in pixels) into which to begin drawing with the grid dash array.",
"type": "array",
"items": {
"type": "number"
}
},
"gridOpacity": {
"description": "The stroke opacity of grid (value between [0,1])",
"type": "number"
},
"gridWidth": {
"description": "The grid width, in pixels.",
"type": "number"
},
"labels": {
"description": "Enable or disable labels.",
"type": "boolean"
},
"labelAngle": {
"description": "The rotation angle of the axis labels.",
"type": "number"
},
"labelAlign": {
"description": "Text alignment for the Label.",
"type": "string"
},
"labelBaseline": {
"description": "Text baseline for the label.",
"type": "string"
},
"labelMaxLength": {
"description": "Truncate labels that are too long.",
"minimum": 1,
"type": "number"
},
"shortTimeLabels": {
"description": "Whether month and day names should be abbreviated.",
"type": "boolean"
},
"subdivide": {
"description": "If provided, sets the number of minor ticks between major ticks (the value 9 results in decimal subdivision). Only applicable for axes visualizing quantitative scales.",
"type": "number"
},
"ticks": {
"description": "A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are \"nice\" (multiples of 2, 5, 10) and lie within the underlying scale's range.",
"minimum": 0,
"type": "number"
},
"tickColor": {
"description": "The color of the axis's tick.",
"type": "string"
},
"tickLabelColor": {
"description": "The color of the tick label, can be in hex color code or regular color name.",
"type": "string"
},
"tickLabelFont": {
"description": "The font of the tick label.",
"type": "string"
},
"tickLabelFontSize": {
"description": "The font size of label, in pixels.",
"type": "number"
},
"tickPadding": {
"description": "The padding, in pixels, between ticks and text labels.",
"type": "number"
},
"tickSize": {
"description": "The size, in pixels, of major, minor and end ticks.",
"minimum": 0,
"type": "number"
},
"tickSizeMajor": {
"description": "The size, in pixels, of major ticks.",
"minimum": 0,
"type": "number"
},
"tickSizeMinor": {
"description": "The size, in pixels, of minor ticks.",
"minimum": 0,
"type": "number"
},
"tickSizeEnd": {
"description": "The size, in pixels, of end ticks.",
"minimum": 0,
"type": "number"
},
"tickWidth": {
"description": "The width, in pixels, of ticks.",
"type": "number"
},
"titleColor": {
"description": "Color of the title, can be in hex color code or regular color name.",
"type": "string"
},
"titleFont": {
"description": "Font of the title.",
"type": "string"
},
"titleFontSize": {
"description": "Size of the title.",
"type": "number"
},
"titleFontWeight": {
"description": "Weight of the title.",
"type": "string"
},
"titleOffset": {
"description": "A title offset value for the axis.",
"type": "number"
},
"titleMaxLength": {
"description": "Max length for axis title if the title is automatically generated from the field's description. By default, this is automatically based on cell size and characterWidth property.",
"minimum": 0,
"type": "number"
},
"characterWidth": {
"description": "Character width for automatically determining title max length.",
"type": "number"
},
"properties": {
"description": "Optional mark property definitions for custom axis styling."
}
}
},
"LegendConfig": {
"type": "object",
"properties": {
"orient": {
"description": "The orientation of the legend. One of \"left\" or \"right\". This determines how the legend is positioned within the scene. The default is \"right\".",
"type": "string"
},
"offset": {
"description": "The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.",
"type": "number"
},
"padding": {
"description": "The padding, in pixels, between the lengend and axis.",
"type": "number"
},
"margin": {
"description": "The margin around the legend, in pixels",
"type": "number"
},
"gradientStrokeColor": {
"description": "The color of the gradient stroke, can be in hex color code or regular color name.",
"type": "string"
},
"gradientStrokeWidth": {
"description": "The width of the gradient stroke, in pixels.",
"type": "number"
},
"gradientHeight": {
"description": "The height of the gradient, in pixels.",
"type": "number"
},
"gradientWidth": {
"description": "The width of the gradient, in pixels.",
"type": "number"
},
"labelAlign": {
"description": "The alignment of the legend label, can be left, middle or right.",
"type": "string"
},
"labelBaseline": {
"description": "The position of the baseline of legend label, can be top, middle or bottom.",
"type": "string"
},
"labelColor": {
"description": "The color of the legend label, can be in hex color code or regular color name.",
"type": "string"
},
"labelFont": {
"description": "The font of the lengend label.",
"type": "string"
},
"labelFontSize": {
"description": "The font size of lengend lable.",
"type": "number"
},
"labelOffset": {
"description": "The offset of the legend label.",
"type": "number"
},
"shortTimeLabels": {
"description": "Whether month names and weekday names should be abbreviated.",
"type": "boolean"
},
"symbolColor": {
"description": "The color of the legend symbol,",
"type": "string"
},
"symbolShape": {
"description": "The shape of the legend symbol, can be the 'circle', 'square', 'cross', 'diamond',\n\n'triangle-up', 'triangle-down', or else a custom SVG path string.",
"type": "string"
},
"symbolSize": {
"description": "The size of the lengend symbol, in pixels.",
"type": "number"
},
"symbolStrokeWidth": {
"description": "The width of the symbol's stroke.",
"type": "number"
},
"titleColor": {
"description": "Optional mark property definitions for custom legend styling.\n\nThe color of the legend title, can be in hex color code or regular color name.",
"type": "string"
},
"titleFont": {
"description": "The font of the legend title.",
"type": "string"
},
"titleFontSize": {
"description": "The font size of the legend title.",
"type": "number"
},
"titleFontWeight": {
"description": "The font weight of the legend title.",
"type": "string"
},
"properties": {
"description": "Optional mark property definitions for custom legend styling."
}
}
},
"FacetConfig": {
"type": "object",
"properties": {
"scale": {
"$ref": "#/definitions/FacetScaleConfig",
"description": "Facet Scale Config"
},
"axis": {
"$ref": "#/definitions/AxisConfig",
"description": "Facet Axis Config"
},
"grid": {
"$ref": "#/definitions/FacetGridConfig",
"description": "Facet Grid Config"
},
"cell": {
"$ref": "#/definitions/CellConfig",
"description": "Facet Cell Config"
}
}
},
"FacetScaleConfig": {
"type": "object",
"properties": {
"round": {
"type": "boolean"
},
"padding": {
"type": "number"
}
}
},
"FacetGridConfig": {
"type": "object",
"properties": {
"color": {
"format": "color",
"type": "string"
},
"opacity": {
"type": "number"
},
"offset": {
"type": "number"
}
}
},
"FacetSpec": {
"type": "object",
"properties": {
"facet": {
"$ref": "#/definitions/Facet"
},
"spec": {
"oneOf": [
{
"$ref": "#/definitions/LayerSpec"
},
{
"$ref": "#/definitions/UnitSpec"
}
]
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"description": {
"description": "An optional description of this mark for commenting purpose.\n\nThis property has no effect on the output visualization.",
"type": "string"
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"transform": {
"$ref": "#/definitions/Transform",
"description": "An object describing filter and new field calculation."
},
"config": {
"$ref": "#/definitions/Config",
"description": "Configuration object"
}
},
"required": [
"facet",
"spec"
]
},
"Facet": {
"type": "object",
"properties": {
"row": {
"$ref": "#/definitions/PositionChannelDef"
},
"column": {
"$ref": "#/definitions/PositionChannelDef"
}
}
},
"LayerSpec": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"layers": {
"description": "Unit specs that will be layered.",
"type": "array",
"items": {
"$ref": "#/definitions/UnitSpec"
}
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"description": {
"description": "An optional description of this mark for commenting purpose.\n\nThis property has no effect on the output visualization.",
"type": "string"
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"transform": {
"$ref": "#/definitions/Transform",
"description": "An object describing filter and new field calculation."
},
"config": {
"$ref": "#/definitions/Config",
"description": "Configuration object"
}
},
"required": [
"layers"
]
},
"UnitSpec": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"mark": {
"$ref": "#/definitions/Mark",
"description": "The mark type.\n\nOne of `\"bar\"`, `\"circle\"`, `\"square\"`, `\"tick\"`, `\"line\"`,\n\n`\"area\"`, `\"point\"`, `\"rule\"`, and `\"text\"`."
},
"encoding": {
"$ref": "#/definitions/UnitEncoding",
"description": "A key-value mapping between encoding channels and definition of fields."
},
"name": {
"description": "Name of the visualization for later reference.",
"type": "string"
},
"description": {
"description": "An optional description of this mark for commenting purpose.\n\nThis property has no effect on the output visualization.",
"type": "string"
},
"data": {
"$ref": "#/definitions/Data",
"description": "An object describing the data source"
},
"transform": {
"$ref": "#/definitions/Transform",
"description": "An object describing filter and new field calculation."
},
"config": {
"$ref": "#/definitions/Config",
"description": "Configuration object"
}
},
"required": [
"mark"
]
},
"UnitEncoding": {
"type": "object",
"properties": {
"x": {
"$ref": "#/definitions/PositionChannelDef",
"description": "X coordinates for `point`, `circle`, `square`,\n\n`line`, `rule`, `text`, and `tick`\n\n(or to width and height for `bar` and `area` marks)."
},
"y": {
"$ref": "#/definitions/PositionChannelDef",
"description": "Y coordinates for `point`, `circle`, `square`,\n\n`line`, `rule`, `text`, and `tick`\n\n(or to width and height for `bar` and `area` marks)."
},
"x2": {
"$ref": "#/definitions/FieldDef",
"description": "X2 coordinates for ranged `bar`, `rule`, `area`"
},
"y2": {
"$ref": "#/definitions/FieldDef",
"description": "Y2 coordinates for ranged `bar`, `rule`, `area`"
},
"color": {
"$ref": "#/definitions/ChannelDefWithLegend",
"description": "Color of the marks \u2013 either fill or stroke color based on mark type.\n\n(By default, fill color for `area`, `bar`, `tick`, `text`, `circle`, and `square` /\n\nstroke color for `line` and `point`.)"
},
"opacity": {
"$ref": "#/definitions/ChannelDefWithLegend",
"description": "Opacity of the marks \u2013 either can be a value or in a range."
},
"size": {
"$ref": "#/definitions/ChannelDefWithLegend",
"description": "Size of the mark.\n\n- For `point`, `square` and `circle`\n\n\u2013 the symbol size, or pixel area of the mark.\n\n- For `bar` and `tick` \u2013 the bar and tick's size.\n\n- For `text` \u2013 the text's font size.\n\n- Size is currently unsupported for `line` and `area`."
},
"shape": {
"$ref": "#/definitions/ChannelDefWithLegend",
"description": "The symbol's shape (only for `point` marks). The supported values are\n\n`\"circle\"` (default), `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`,\n\nor `\"triangle-down\"`, or else a custom SVG path string."
},
"detail": {
"description": "Additional levels of detail for grouping data in aggregate views and\n\nin line and area marks without mapping data to a specific visual channel.",
"oneOf": [
{
"$ref": "#/definitions/FieldDef",
"description": "Interface for any kind of FieldDef;\n\nFor simplicity, we do not declare multiple interfaces of FieldDef like\n\nwe do for JSON schema."
},
{
"type": "array",
"items": {
"$ref": "#/definitions/FieldDef",
"description": "Interface for any kind of FieldDef;\n\nFor simplicity, we do not declare multiple interfaces of FieldDef like\n\nwe do for JSON schema."
}
}
]
},
"text": {
"$ref": "#/definitions/FieldDef",
"description": "Text of the `text` mark."
},
"label": {
"$ref": "#/definitions/FieldDef"
},
"path": {
"description": "Order of data points in line marks.",
"oneOf": [
{
"$ref": "#/definitions/OrderChannelDef"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/OrderChannelDef"
}
}
]
},
"order": {
"description": "Layer order for non-stacked marks, or stack order for stacked marks.",
"oneOf": [
{
"$ref": "#/definitions/OrderChannelDef"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/OrderChannelDef"
}
}
]
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
} | o83932 |
{
"additionalProperties": false,
"definitions": {
"healthMonitorType": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
]
},
{
"additionalProperties": false,
"properties": {
"interval": {
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"name": {
"minLength": 1,
"type": "string"
},
"recv": {
"minLength": 1,
"type": "string"
},
"send": {
"minLength": 1,
"type": "string"
},
"timeout": {
"maximum": 86400,
"minimum": 1,
"type": "integer"
},
"type": {
"enum": [
"http",
"tcp"
],
"type": "string"
}
},
"required": [
"name",
"type"
]
}
],
"type": "object"
},
"policyType": {
"minLength": 1,
"type": "string"
},
"poolType": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"balance"
]
},
{
"required": [
"healthMonitors"
]
}
],
"properties": {
"balance": {
"minLength": 1,
"type": "string"
},
"healthMonitors": {
"additionalItems": false,
"items": {
"$ref": "#/definitions/healthMonitorType"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"profileType": {
"minLength": 1,
"type": "string"
},
"sslProfileType": {
"minLength": 1,
"type": "string"
},
"virtualServerType": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"profiles"
]
},
{
"required": [
"policies"
]
},
{
"required": [
"sslProfiles"
]
}
],
"properties": {
"policies": {
"items": {
"$ref": "#/definitions/policyType"
},
"minItems": 1,
"type": "array"
},
"profiles": {
"items": {
"$ref": "#/definitions/profileType"
},
"minItems": 1,
"type": "array"
},
"sslProfiles": {
"items": {
"$ref": "#/definitions/sslProfileType"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
},
"properties": {
"plans": {
"items": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"pool"
]
},
{
"required": [
"virtualServer"
]
}
],
"properties": {
"description": {
"minLength": 1,
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"pool": {
"$ref": "#/definitions/poolType"
},
"virtualServer": {
"$ref": "#/definitions/virtualServerType"
}
},
"required": [
"name",
"description"
]
},
"minItems": 1,
"type": "array"
}
},
"required": [
"plans"
],
"type": "object"
} | o71820 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Canada provincial postal abbreviations",
"description": "Postal abbreviations for provinces and territories of Canada",
"id": "http://localhost:8081/schema/postCanadaCommon_schema.json",
"definitions": {
"CAN_province": {
"type": "string",
"enum": [
"AB",
"BC",
"MB",
"NB",
"NL",
"NS",
"NT",
"NU",
"ON",
"PE",
"QC",
"SK",
"YT"
]
},
"CAN_postalCode": {
"type": "string",
"pattern": "^[A-Z][0-9][A-Z]( )?[0-9][A-Z][0-9]$"
}
},
"properties": {
"CAN_province": {
"$ref": "#/definitions/CAN_province"
},
"CAN_postalCode": {
"$ref": "#/definitions/CAN_postalCode"
}
},
"required": [
"CAN_province",
"CAN_postalCode"
]
} | o83738 |
{
"$id": "https://json.schemastore.org/sarif-2.1.0-rtm.3.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"address": {
"description": "A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).",
"additionalProperties": false,
"type": "object",
"properties": {
"absoluteAddress": {
"description": "The address expressed as a byte offset from the start of the addressable region.",
"type": "integer",
"minimum": -1,
"default": -1
},
"relativeAddress": {
"description": "The address expressed as a byte offset from the absolute address of the top-most parent object.",
"type": "integer"
},
"length": {
"description": "The number of bytes in this range of addresses.",
"type": "integer"
},
"kind": {
"description": "An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.",
"type": "string"
},
"name": {
"description": "A name that is associated with the address, e.g., '.text'.",
"type": "string"
},
"fullyQualifiedName": {
"description": "A human-readable fully qualified name that is associated with the address.",
"type": "string"
},
"offsetFromParent": {
"description": "The byte offset of this address from the absolute or relative address of the parent object.",
"type": "integer"
},
"index": {
"description": "The index within run.addresses of the cached object for this address.",
"type": "integer",
"default": -1,
"minimum": -1
},
"parentIndex": {
"description": "The index within run.addresses of the parent object.",
"type": "integer",
"default": -1,
"minimum": -1
},
"properties": {
"description": "Key/value pairs that provide additional information about the address.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifact": {
"description": "A single artifact. In some cases, this artifact might be nested within another artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A short description of the artifact.",
"$ref": "#/definitions/message"
},
"location": {
"description": "The location of the artifact.",
"$ref": "#/definitions/artifactLocation"
},
"parentIndex": {
"description": "Identifies the index of the immediate parent of the artifact, if this artifact is nested.",
"type": "integer",
"default": -1,
"minimum": -1
},
"offset": {
"description": "The offset in bytes of the artifact within its containing artifact.",
"type": "integer",
"minimum": 0
},
"length": {
"description": "The length of the artifact in bytes.",
"type": "integer",
"default": -1,
"minimum": -1
},
"roles": {
"description": "The role or roles played by the artifact in the analysis.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"enum": [
"analysisTarget",
"attachment",
"responseFile",
"resultFile",
"standardStream",
"tracedFile",
"unmodified",
"modified",
"added",
"deleted",
"renamed",
"uncontrolled",
"driver",
"extension",
"translation",
"taxonomy",
"policy",
"referencedOnCommandLine",
"memoryContents",
"directory",
"userSpecifiedConfiguration",
"toolSpecifiedConfiguration",
"debugOutputFile"
]
}
},
"mimeType": {
"description": "The MIME type (RFC 2045) of the artifact.",
"type": "string",
"pattern": "[^/]+/.+"
},
"contents": {
"description": "The contents of the artifact.",
"$ref": "#/definitions/artifactContent"
},
"encoding": {
"description": "Specifies the encoding for an artifact object that refers to a text file.",
"type": "string"
},
"sourceLanguage": {
"description": "Specifies the source language for any artifact object that refers to a text file that contains source code.",
"type": "string"
},
"hashes": {
"description": "A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"lastModifiedTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifactChange": {
"description": "A change to a single artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"artifactLocation": {
"description": "The location of the artifact to change.",
"$ref": "#/definitions/artifactLocation"
},
"replacements": {
"description": "An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/replacement"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the change.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactLocation", "replacements"]
},
"artifactContent": {
"description": "Represents the contents of an artifact.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "UTF-8-encoded content from a text artifact.",
"type": "string"
},
"binary": {
"description": "MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.",
"type": "string"
},
"rendered": {
"description": "An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).",
"$ref": "#/definitions/multiformatMessageString"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact content.",
"$ref": "#/definitions/propertyBag"
}
}
},
"artifactLocation": {
"description": "Specifies the location of an artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"uri": {
"description": "A string containing a valid relative or absolute URI.",
"type": "string",
"format": "uri-reference"
},
"uriBaseId": {
"description": "A string which indirectly specifies the absolute URI with respect to which a relative URI in the \"uri\" property is interpreted.",
"type": "string"
},
"index": {
"description": "The index within the run artifacts array of the artifact object associated with the artifact location.",
"type": "integer",
"default": -1,
"minimum": -1
},
"description": {
"description": "A short description of the artifact location.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the artifact location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"attachment": {
"description": "An artifact relevant to a result.",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "A message describing the role played by the attachment.",
"$ref": "#/definitions/message"
},
"artifactLocation": {
"description": "The location of the attachment.",
"$ref": "#/definitions/artifactLocation"
},
"regions": {
"description": "An array of regions of interest within the attachment.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/region"
}
},
"rectangles": {
"description": "An array of rectangles specifying areas of interest within the image.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/rectangle"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the attachment.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactLocation"]
},
"codeFlow": {
"description": "A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"description": "A message relevant to the code flow.",
"$ref": "#/definitions/message"
},
"threadFlows": {
"description": "An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/threadFlow"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the code flow.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["threadFlows"]
},
"configurationOverride": {
"description": "Information about how a specific rule or notification was reconfigured at runtime.",
"type": "object",
"additionalProperties": false,
"properties": {
"configuration": {
"description": "Specifies how the rule or notification was configured during the scan.",
"$ref": "#/definitions/reportingConfiguration"
},
"descriptor": {
"description": "A reference used to locate the descriptor whose configuration was overridden.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the configuration override.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["configuration", "descriptor"]
},
"conversion": {
"description": "Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.",
"additionalProperties": false,
"type": "object",
"properties": {
"tool": {
"description": "A tool object that describes the converter.",
"$ref": "#/definitions/tool"
},
"invocation": {
"description": "An invocation object that describes the invocation of the converter.",
"$ref": "#/definitions/invocation"
},
"analysisToolLogFiles": {
"description": "The locations of the analysis tool's per-run log files.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the conversion.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["tool"]
},
"edge": {
"description": "Represents a directed edge in a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the edge within its graph.",
"type": "string"
},
"label": {
"description": "A short description of the edge.",
"$ref": "#/definitions/message"
},
"sourceNodeId": {
"description": "Identifies the source node (the node at which the edge starts).",
"type": "string"
},
"targetNodeId": {
"description": "Identifies the target node (the node at which the edge ends).",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the edge.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id", "sourceNodeId", "targetNodeId"]
},
"edgeTraversal": {
"description": "Represents the traversal of a single edge during a graph traversal.",
"type": "object",
"additionalProperties": false,
"properties": {
"edgeId": {
"description": "Identifies the edge being traversed.",
"type": "string"
},
"message": {
"description": "A message to display to the user as the edge is traversed.",
"$ref": "#/definitions/message"
},
"finalState": {
"description": "The values of relevant expressions after the edge has been traversed.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"stepOverEdgeCount": {
"description": "The number of edge traversals necessary to return from a nested graph.",
"type": "integer",
"minimum": 0
},
"properties": {
"description": "Key/value pairs that provide additional information about the edge traversal.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["edgeId"]
},
"exception": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal."
},
"message": {
"description": "A message that describes the exception.",
"type": "string"
},
"stack": {
"description": "The sequence of function calls leading to the exception.",
"$ref": "#/definitions/stack"
},
"innerExceptions": {
"description": "An array of exception objects each of which is considered a cause of this exception.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/exception"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the exception.",
"$ref": "#/definitions/propertyBag"
}
}
},
"externalProperties": {
"type": "object",
"properties": {
"schema": {
"description": "The URI of the JSON schema corresponding to the version of the external property file format.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this external properties object.",
"enum": ["2.1.0"]
},
"guid": {
"description": "A stable, unique identifier for this external properties object, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"runGuid": {
"description": "A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"conversion": {
"description": "A conversion object that will be merged with a separate run.",
"$ref": "#/definitions/conversion"
},
"graphs": {
"description": "An array of graph objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/graph"
}
},
"externalizedProperties": {
"description": "Key/value pairs that provide additional information that will be merged with a separate run.",
"$ref": "#/definitions/propertyBag"
},
"artifacts": {
"description": "An array of artifact objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifact"
}
},
"invocations": {
"description": "Describes the invocation of the analysis tool that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/invocation"
}
},
"logicalLocations": {
"description": "An array of logical locations such as namespaces, types or functions that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"threadFlowLocations": {
"description": "An array of threadFlowLocation objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"results": {
"description": "An array of result objects that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/result"
}
},
"taxonomies": {
"description": "Tool taxonomies that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"driver": {
"description": "The analysis tool object that will be merged with a separate run.",
"$ref": "#/definitions/toolComponent"
},
"extensions": {
"description": "Tool extensions that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"policies": {
"description": "Tool policies that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"translations": {
"description": "Tool translations that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"addresses": {
"description": "Addresses that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/address"
}
},
"webRequests": {
"description": "Requests that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webRequest"
}
},
"webResponses": {
"description": "Responses that will be merged with a separate run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webResponse"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the external properties.",
"$ref": "#/definitions/propertyBag"
}
}
},
"externalPropertyFileReference": {
"type": "object",
"properties": {
"location": {
"description": "The location of the external property file.",
"$ref": "#/definitions/artifactLocation"
},
"guid": {
"description": "A stable, unique identifier for the external property file in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"itemCount": {
"description": "A non-negative integer specifying the number of items contained in the external property file.",
"type": "integer",
"default": -1,
"minimum": -1
},
"properties": {
"description": "Key/value pairs that provide additional information about the external property file.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["location"]
},
{
"required": ["guid"]
}
]
},
"externalPropertyFileReferences": {
"description": "References to external property files that should be inlined with the content of a root log file.",
"additionalProperties": false,
"type": "object",
"properties": {
"conversion": {
"description": "An external property file containing a run.conversion object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"graphs": {
"description": "An array of external property files containing a run.graphs object to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"externalizedProperties": {
"description": "An external property file containing a run.properties object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"artifacts": {
"description": "An array of external property files containing run.artifacts arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"invocations": {
"description": "An array of external property files containing run.invocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"logicalLocations": {
"description": "An array of external property files containing run.logicalLocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"threadFlowLocations": {
"description": "An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"results": {
"description": "An array of external property files containing run.results arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"taxonomies": {
"description": "An array of external property files containing run.taxonomies arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"addresses": {
"description": "An array of external property files containing run.addresses arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"driver": {
"description": "An external property file containing a run.driver object to be merged with the root log file.",
"$ref": "#/definitions/externalPropertyFileReference"
},
"extensions": {
"description": "An array of external property files containing run.extensions arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"policies": {
"description": "An array of external property files containing run.policies arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"translations": {
"description": "An array of external property files containing run.translations arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"webRequests": {
"description": "An array of external property files containing run.requests arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"webResponses": {
"description": "An array of external property files containing run.responses arrays to be merged with the root log file.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/externalPropertyFileReference"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the external property files.",
"$ref": "#/definitions/propertyBag"
}
}
},
"fix": {
"description": "A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.",
"$ref": "#/definitions/message"
},
"artifactChanges": {
"description": "One or more artifact changes that comprise a fix for a result.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifactChange"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the fix.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["artifactChanges"]
},
"graph": {
"description": "A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the graph.",
"$ref": "#/definitions/message"
},
"nodes": {
"description": "An array of node objects representing the nodes of the graph.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/node"
}
},
"edges": {
"description": "An array of edge objects representing the edges of the graph.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/edge"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the graph.",
"$ref": "#/definitions/propertyBag"
}
}
},
"graphTraversal": {
"description": "Represents a path through a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"runGraphIndex": {
"description": "The index within the run.graphs to be associated with the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"resultGraphIndex": {
"description": "The index within the result.graphs to be associated with the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"description": {
"description": "A description of this graph traversal.",
"$ref": "#/definitions/message"
},
"initialState": {
"description": "Values of relevant expressions at the start of the graph traversal that may change during graph traversal.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"immutableState": {
"description": "Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"edgeTraversals": {
"description": "The sequences of edges traversed by this graph traversal.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/edgeTraversal"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the graph traversal.",
"$ref": "#/definitions/propertyBag"
}
},
"oneOf": [
{
"required": ["runGraphIndex"]
},
{
"required": ["resultGraphIndex"]
}
]
},
"invocation": {
"description": "The runtime environment of the analysis tool run.",
"additionalProperties": false,
"type": "object",
"properties": {
"commandLine": {
"description": "The command line used to invoke the tool.",
"type": "string"
},
"arguments": {
"description": "An array of strings, containing in order the command line arguments passed to the tool from the operating system.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"type": "string"
}
},
"responseFiles": {
"description": "The locations of any response files specified on the tool's command line.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"startTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the run started. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"endTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the run ended. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"exitCode": {
"description": "The process exit code.",
"type": "integer"
},
"ruleConfigurationOverrides": {
"description": "An array of configurationOverride objects that describe rules related runtime overrides.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/configurationOverride"
}
},
"notificationConfigurationOverrides": {
"description": "An array of configurationOverride objects that describe notifications related runtime overrides.",
"type": "array",
"minItems": 0,
"default": [],
"uniqueItems": true,
"items": {
"$ref": "#/definitions/configurationOverride"
}
},
"toolExecutionNotifications": {
"description": "A list of runtime conditions detected by the tool during the analysis.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/notification"
}
},
"toolConfigurationNotifications": {
"description": "A list of conditions detected by the tool that are relevant to the tool's configuration.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/notification"
}
},
"exitCodeDescription": {
"description": "The reason for the process exit.",
"type": "string"
},
"exitSignalName": {
"description": "The name of the signal that caused the process to exit.",
"type": "string"
},
"exitSignalNumber": {
"description": "The numeric value of the signal that caused the process to exit.",
"type": "integer"
},
"processStartFailureMessage": {
"description": "The reason given by the operating system that the process failed to start.",
"type": "string"
},
"executionSuccessful": {
"description": "Specifies whether the tool's execution completed successfully.",
"type": "boolean"
},
"machine": {
"description": "The machine that hosted the analysis tool run.",
"type": "string"
},
"account": {
"description": "The account that ran the analysis tool.",
"type": "string"
},
"processId": {
"description": "The process id for the analysis tool run.",
"type": "integer"
},
"executableLocation": {
"description": "An absolute URI specifying the location of the analysis tool's executable.",
"$ref": "#/definitions/artifactLocation"
},
"workingDirectory": {
"description": "The working directory for the analysis tool run.",
"$ref": "#/definitions/artifactLocation"
},
"environmentVariables": {
"description": "The environment variables associated with the analysis tool process, expressed as key/value pairs.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stdin": {
"description": "A file containing the standard input stream to the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stdout": {
"description": "A file containing the standard output stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stderr": {
"description": "A file containing the standard error stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"stdoutStderr": {
"description": "A file containing the interleaved standard output and standard error stream from the process that was invoked.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the invocation.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["executionSuccessful"]
},
"location": {
"description": "A location within a programming artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "Value that distinguishes this location from all other locations within a single result object.",
"type": "integer",
"minimum": -1,
"default": -1
},
"physicalLocation": {
"description": "Identifies the artifact and region.",
"$ref": "#/definitions/physicalLocation"
},
"logicalLocations": {
"description": "The logical locations associated with the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"message": {
"description": "A message relevant to the location.",
"$ref": "#/definitions/message"
},
"annotations": {
"description": "A set of regions relevant to the location.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/region"
}
},
"relationships": {
"description": "An array of objects that describe relationships between this location and others.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/locationRelationship"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"locationRelationship": {
"description": "Information about the relation of one location to another.",
"type": "object",
"additionalProperties": false,
"properties": {
"target": {
"description": "A reference to the related location.",
"type": "integer",
"minimum": 0
},
"kinds": {
"description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.",
"type": "array",
"default": ["relevant"],
"uniqueItems": true,
"items": {
"type": "string"
}
},
"description": {
"description": "A description of the location relationship.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the location relationship.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["target"]
},
"logicalLocation": {
"description": "A logical location of a construct that produced a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"name": {
"description": "Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.",
"type": "string"
},
"index": {
"description": "The index within the logical locations array.",
"type": "integer",
"default": -1,
"minimum": -1
},
"fullyQualifiedName": {
"description": "The human-readable fully qualified name of the logical location.",
"type": "string"
},
"decoratedName": {
"description": "The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.",
"type": "string"
},
"parentIndex": {
"description": "Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.",
"type": "integer",
"default": -1,
"minimum": -1
},
"kind": {
"description": "The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the logical location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"message": {
"description": "Encapsulates a message intended to be read by the end user.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "A plain text message string.",
"type": "string"
},
"markdown": {
"description": "A Markdown message string.",
"type": "string"
},
"id": {
"description": "The identifier for this message.",
"type": "string"
},
"arguments": {
"description": "An array of strings to substitute into the message string.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"type": "string"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the message.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["text"]
},
{
"required": ["id"]
}
]
},
"multiformatMessageString": {
"description": "A message string or message format string rendered in multiple formats.",
"type": "object",
"additionalProperties": false,
"properties": {
"text": {
"description": "A plain text message string or format string.",
"type": "string"
},
"markdown": {
"description": "A Markdown message string or format string.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the message.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["text"]
},
"node": {
"description": "Represents a node in a graph.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "A string that uniquely identifies the node within its graph.",
"type": "string"
},
"label": {
"description": "A short description of the node.",
"$ref": "#/definitions/message"
},
"location": {
"description": "A code location associated with the node.",
"$ref": "#/definitions/location"
},
"children": {
"description": "Array of child nodes.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/node"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the node.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id"]
},
"notification": {
"description": "Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.",
"type": "object",
"additionalProperties": false,
"properties": {
"locations": {
"description": "The locations relevant to this notification.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"message": {
"description": "A message that describes the condition that was encountered.",
"$ref": "#/definitions/message"
},
"level": {
"description": "A value specifying the severity level of the notification.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"threadId": {
"description": "The thread identifier of the code that generated the notification.",
"type": "integer"
},
"timeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.",
"type": "string",
"format": "date-time"
},
"exception": {
"description": "The runtime exception, if any, relevant to this notification.",
"$ref": "#/definitions/exception"
},
"descriptor": {
"description": "A reference used to locate the descriptor relevant to this notification.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"associatedRule": {
"description": "A reference used to locate the rule descriptor associated with this notification.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the notification.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["message"]
},
"physicalLocation": {
"description": "A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"address": {
"description": "The address of the location.",
"$ref": "#/definitions/address"
},
"artifactLocation": {
"description": "The location of the artifact.",
"$ref": "#/definitions/artifactLocation"
},
"region": {
"description": "Specifies a portion of the artifact.",
"$ref": "#/definitions/region"
},
"contextRegion": {
"description": "Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.",
"$ref": "#/definitions/region"
},
"properties": {
"description": "Key/value pairs that provide additional information about the physical location.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["address"]
},
{
"required": ["artifactLocation"]
}
]
},
"propertyBag": {
"description": "Key/value pairs that provide additional information about the object.",
"type": "object",
"additionalProperties": true,
"properties": {
"tags": {
"description": "A set of distinct strings that provide additional information.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
}
}
},
"rectangle": {
"description": "An area within an image.",
"additionalProperties": false,
"type": "object",
"properties": {
"top": {
"description": "The Y coordinate of the top edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"left": {
"description": "The X coordinate of the left edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"bottom": {
"description": "The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"right": {
"description": "The X coordinate of the right edge of the rectangle, measured in the image's natural units.",
"type": "number"
},
"message": {
"description": "A message relevant to the rectangle.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the rectangle.",
"$ref": "#/definitions/propertyBag"
}
}
},
"region": {
"description": "A region within an artifact where a result was detected.",
"additionalProperties": false,
"type": "object",
"properties": {
"startLine": {
"description": "The line number of the first character in the region.",
"type": "integer",
"minimum": 1
},
"startColumn": {
"description": "The column number of the first character in the region.",
"type": "integer",
"minimum": 1
},
"endLine": {
"description": "The line number of the last character in the region.",
"type": "integer",
"minimum": 1
},
"endColumn": {
"description": "The column number of the character following the end of the region.",
"type": "integer",
"minimum": 1
},
"charOffset": {
"description": "The zero-based offset from the beginning of the artifact of the first character in the region.",
"type": "integer",
"default": -1,
"minimum": -1
},
"charLength": {
"description": "The length of the region in characters.",
"type": "integer",
"minimum": 0
},
"byteOffset": {
"description": "The zero-based offset from the beginning of the artifact of the first byte in the region.",
"type": "integer",
"default": -1,
"minimum": -1
},
"byteLength": {
"description": "The length of the region in bytes.",
"type": "integer",
"minimum": 0
},
"snippet": {
"description": "The portion of the artifact contents within the specified region.",
"$ref": "#/definitions/artifactContent"
},
"message": {
"description": "A message relevant to the region.",
"$ref": "#/definitions/message"
},
"sourceLanguage": {
"description": "Specifies the source language, if any, of the portion of the artifact specified by the region object.",
"type": "string"
},
"properties": {
"description": "Key/value pairs that provide additional information about the region.",
"$ref": "#/definitions/propertyBag"
}
}
},
"replacement": {
"description": "The replacement of a single region of an artifact.",
"additionalProperties": false,
"type": "object",
"properties": {
"deletedRegion": {
"description": "The region of the artifact to delete.",
"$ref": "#/definitions/region"
},
"insertedContent": {
"description": "The content to insert at the location specified by the 'deletedRegion' property.",
"$ref": "#/definitions/artifactContent"
},
"properties": {
"description": "Key/value pairs that provide additional information about the replacement.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["deletedRegion"]
},
"reportingDescriptor": {
"description": "Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.",
"additionalProperties": false,
"type": "object",
"properties": {
"id": {
"description": "A stable, opaque identifier for the report.",
"type": "string"
},
"deprecatedIds": {
"description": "An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"guid": {
"description": "A unique identifier for the reporting descriptor in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"deprecatedGuids": {
"description": "An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"name": {
"description": "A report identifier that is understandable to an end user.",
"type": "string"
},
"deprecatedNames": {
"description": "An array of readable identifiers by which this report was known in some previous version of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"shortDescription": {
"description": "A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.",
"$ref": "#/definitions/multiformatMessageString"
},
"messageStrings": {
"description": "A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"defaultConfiguration": {
"description": "Default reporting configuration information.",
"$ref": "#/definitions/reportingConfiguration"
},
"helpUri": {
"description": "A URI where the primary documentation for the report can be found.",
"type": "string",
"format": "uri"
},
"help": {
"description": "Provides the primary documentation for the report, useful when there is no online documentation.",
"$ref": "#/definitions/multiformatMessageString"
},
"relationships": {
"description": "An array of objects that describe relationships between this reporting descriptor and others.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorRelationship"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the report.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["id"]
},
"reportingConfiguration": {
"description": "Information about a rule or notification that can be configured at runtime.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Specifies whether the report may be produced during the scan.",
"type": "boolean",
"default": true
},
"level": {
"description": "Specifies the failure level for the report.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"rank": {
"description": "Specifies the relative priority of the report. Used for analysis output only.",
"type": "number",
"default": -1,
"minimum": -1,
"maximum": 100
},
"parameters": {
"description": "Contains configuration information specific to a report.",
"$ref": "#/definitions/propertyBag"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting configuration.",
"$ref": "#/definitions/propertyBag"
}
}
},
"reportingDescriptorReference": {
"description": "Information about how to locate a relevant reporting descriptor.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "The id of the descriptor.",
"type": "string"
},
"index": {
"description": "The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.",
"type": "integer",
"default": -1,
"minimum": -1
},
"guid": {
"description": "A guid that uniquely identifies the descriptor.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"toolComponent": {
"description": "A reference used to locate the toolComponent associated with the descriptor.",
"$ref": "#/definitions/toolComponentReference"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting descriptor reference.",
"$ref": "#/definitions/propertyBag"
}
},
"anyOf": [
{
"required": ["index"]
},
{
"required": ["guid"]
},
{
"required": ["id"]
}
]
},
"reportingDescriptorRelationship": {
"description": "Information about the relation of one reporting descriptor to another.",
"type": "object",
"additionalProperties": false,
"properties": {
"target": {
"description": "A reference to the related reporting descriptor.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"kinds": {
"description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.",
"type": "array",
"default": ["relevant"],
"uniqueItems": true,
"items": {
"type": "string"
}
},
"description": {
"description": "A description of the reporting descriptor relationship.",
"$ref": "#/definitions/message"
},
"properties": {
"description": "Key/value pairs that provide additional information about the reporting descriptor reference.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["target"]
},
"result": {
"description": "A result produced by an analysis tool.",
"additionalProperties": false,
"type": "object",
"properties": {
"ruleId": {
"description": "The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
"type": "string"
},
"ruleIndex": {
"description": "The index within the tool component rules array of the rule object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"rule": {
"description": "A reference used to locate the rule descriptor relevant to this result.",
"$ref": "#/definitions/reportingDescriptorReference"
},
"kind": {
"description": "A value that categorizes results by evaluation state.",
"default": "fail",
"enum": [
"notApplicable",
"pass",
"fail",
"review",
"open",
"informational"
]
},
"level": {
"description": "A value specifying the severity level of the result.",
"default": "warning",
"enum": ["none", "note", "warning", "error"]
},
"message": {
"description": "A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.",
"$ref": "#/definitions/message"
},
"analysisTarget": {
"description": "Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.",
"$ref": "#/definitions/artifactLocation"
},
"locations": {
"description": "The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"guid": {
"description": "A stable, unique identifier for the result in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"correlationGuid": {
"description": "A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"occurrenceCount": {
"description": "A positive integer specifying the number of times this logically unique result was observed in this run.",
"type": "integer",
"minimum": 1
},
"partialFingerprints": {
"description": "A set of strings that contribute to the stable, unique identity of the result.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fingerprints": {
"description": "A set of strings each of which individually defines a stable, unique identity for the result.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"stacks": {
"description": "An array of 'stack' objects relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/stack"
}
},
"codeFlows": {
"description": "An array of 'codeFlow' objects relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/codeFlow"
}
},
"graphs": {
"description": "An array of zero or more unique graph objects associated with the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graph"
}
},
"graphTraversals": {
"description": "An array of one or more unique 'graphTraversal' objects.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graphTraversal"
}
},
"relatedLocations": {
"description": "A set of locations relevant to this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/location"
}
},
"suppressions": {
"description": "A set of suppressions relevant to this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/suppression"
}
},
"baselineState": {
"description": "The state of a result relative to a baseline of a previous run.",
"enum": ["new", "unchanged", "updated", "absent"]
},
"rank": {
"description": "A number representing the priority or importance of the result.",
"type": "number",
"default": -1,
"minimum": -1,
"maximum": 100
},
"attachments": {
"description": "A set of artifacts relevant to the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/attachment"
}
},
"hostedViewerUri": {
"description": "An absolute URI at which the result can be viewed.",
"type": "string",
"format": "uri"
},
"workItemUris": {
"description": "The URIs of the work items associated with this result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"format": "uri"
}
},
"provenance": {
"description": "Information about how and when the result was detected.",
"$ref": "#/definitions/resultProvenance"
},
"fixes": {
"description": "An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/fix"
}
},
"taxa": {
"description": "An array of references to taxonomy reporting descriptors that are applicable to the result.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorReference"
}
},
"webRequest": {
"description": "A web request associated with this result.",
"$ref": "#/definitions/webRequest"
},
"webResponse": {
"description": "A web response associated with this result.",
"$ref": "#/definitions/webResponse"
},
"properties": {
"description": "Key/value pairs that provide additional information about the result.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["message"]
},
"resultProvenance": {
"description": "Contains information about how and when a result was detected.",
"additionalProperties": false,
"type": "object",
"properties": {
"firstDetectionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the result was first detected. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"lastDetectionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See \"Date/time properties\" in the SARIF spec for the required format.",
"type": "string",
"format": "date-time"
},
"firstDetectionRunGuid": {
"description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"lastDetectionRunGuid": {
"description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"invocationIndex": {
"description": "The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"conversionSources": {
"description": "An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/physicalLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the result.",
"$ref": "#/definitions/propertyBag"
}
}
},
"run": {
"description": "Describes a single run of an analysis tool, and contains the reported output of that run.",
"additionalProperties": false,
"type": "object",
"properties": {
"tool": {
"description": "Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.",
"$ref": "#/definitions/tool"
},
"invocations": {
"description": "Describes the invocation of the analysis tool.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/invocation"
}
},
"conversion": {
"description": "A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.",
"$ref": "#/definitions/conversion"
},
"language": {
"description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).",
"type": "string",
"default": "en-US",
"pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$"
},
"versionControlProvenance": {
"description": "Specifies the revision in version control of the artifacts that were scanned.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/versionControlDetails"
}
},
"originalUriBaseIds": {
"description": "The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/artifactLocation"
}
},
"artifacts": {
"description": "An array of artifact objects relevant to the run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/artifact"
}
},
"logicalLocations": {
"description": "An array of logical locations such as namespaces, types or functions.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/logicalLocation"
}
},
"graphs": {
"description": "An array of zero or more unique graph objects associated with the run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/graph"
}
},
"results": {
"description": "The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/result"
}
},
"automationDetails": {
"description": "Automation details that describe this run.",
"$ref": "#/definitions/runAutomationDetails"
},
"runAggregates": {
"description": "Automation details that describe the aggregate of runs to which this run belongs.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/runAutomationDetails"
}
},
"baselineGuid": {
"description": "The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"redactionTokens": {
"description": "An array of strings used to replace sensitive information in a redaction-aware property.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
},
"defaultEncoding": {
"description": "Specifies the default encoding for any artifact object that refers to a text file.",
"type": "string"
},
"defaultSourceLanguage": {
"description": "Specifies the default source language for any artifact object that refers to a text file that contains source code.",
"type": "string"
},
"newlineSequences": {
"description": "An ordered list of character sequences that were treated as line breaks when computing region information for the run.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"default": ["\r\n", "\n"],
"items": {
"type": "string"
}
},
"columnKind": {
"description": "Specifies the unit in which the tool measures columns.",
"enum": ["utf16CodeUnits", "unicodeCodePoints"]
},
"externalPropertyFileReferences": {
"description": "References to external property files that should be inlined with the content of a root log file.",
"$ref": "#/definitions/externalPropertyFileReferences"
},
"threadFlowLocations": {
"description": "An array of threadFlowLocation objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"taxonomies": {
"description": "An array of toolComponent objects relevant to a taxonomy in which results are categorized.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"addresses": {
"description": "Addresses associated with this run instance, if any.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"$ref": "#/definitions/address"
}
},
"translations": {
"description": "The set of available translations of the localized data provided by the tool.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"policies": {
"description": "Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"webRequests": {
"description": "An array of request objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webRequest"
}
},
"webResponses": {
"description": "An array of response objects cached at run level.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/webResponse"
}
},
"specialLocations": {
"description": "A specialLocations object that defines locations of special significance to SARIF consumers.",
"$ref": "#/definitions/specialLocations"
},
"properties": {
"description": "Key/value pairs that provide additional information about the run.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["tool"]
},
"runAutomationDetails": {
"description": "Information that describes a run's identity and role within an engineering system process.",
"additionalProperties": false,
"type": "object",
"properties": {
"description": {
"description": "A description of the identity and role played within the engineering system by this object's containing run object.",
"$ref": "#/definitions/message"
},
"id": {
"description": "A hierarchical string that uniquely identifies this object's containing run object.",
"type": "string"
},
"guid": {
"description": "A stable, unique identifier for this object's containing run object in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"correlationGuid": {
"description": "A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"properties": {
"description": "Key/value pairs that provide additional information about the run automation details.",
"$ref": "#/definitions/propertyBag"
}
}
},
"specialLocations": {
"description": "Defines locations of special significance to SARIF consumers.",
"type": "object",
"properties": {
"displayBase": {
"description": "Provides a suggestion to SARIF consumers to display file paths relative to the specified location.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the special locations.",
"$ref": "#/definitions/propertyBag"
}
}
},
"stack": {
"description": "A call stack that is relevant to a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"message": {
"description": "A message relevant to this call stack.",
"$ref": "#/definitions/message"
},
"frames": {
"description": "An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/stackFrame"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the stack.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["frames"]
},
"stackFrame": {
"description": "A function call within a stack trace.",
"additionalProperties": false,
"type": "object",
"properties": {
"location": {
"description": "The location to which this stack frame refers.",
"$ref": "#/definitions/location"
},
"module": {
"description": "The name of the module that contains the code of this stack frame.",
"type": "string"
},
"threadId": {
"description": "The thread identifier of the stack frame.",
"type": "integer"
},
"parameters": {
"description": "The parameters of the call that is executing.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"default": [],
"items": {
"type": "string",
"default": []
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the stack frame.",
"$ref": "#/definitions/propertyBag"
}
}
},
"suppression": {
"description": "A suppression that is relevant to a result.",
"additionalProperties": false,
"type": "object",
"properties": {
"guid": {
"description": "A stable, unique identifier for the suppression in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"kind": {
"description": "A string that indicates where the suppression is persisted.",
"enum": ["inSource", "external"]
},
"state": {
"description": "A string that indicates the state of the suppression.",
"enum": ["accepted", "underReview", "rejected"]
},
"justification": {
"description": "A string representing the justification for the suppression.",
"type": "string"
},
"location": {
"description": "Identifies the location associated with the suppression.",
"$ref": "#/definitions/location"
},
"properties": {
"description": "Key/value pairs that provide additional information about the suppression.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["kind"]
},
"threadFlow": {
"type": "object",
"properties": {
"id": {
"description": "An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.",
"type": "string"
},
"message": {
"description": "A message relevant to the thread flow.",
"$ref": "#/definitions/message"
},
"initialState": {
"description": "Values of relevant expressions at the start of the thread flow that may change during thread flow execution.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"immutableState": {
"description": "Values of relevant expressions at the start of the thread flow that remain constant.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"locations": {
"description": "A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.",
"type": "array",
"minItems": 1,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/threadFlowLocation"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the thread flow.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["locations"]
},
"threadFlowLocation": {
"description": "A location visited by an analysis tool while simulating or monitoring the execution of a program.",
"additionalProperties": false,
"type": "object",
"properties": {
"index": {
"description": "The index within the run threadFlowLocations array.",
"type": "integer",
"default": -1,
"minimum": -1
},
"location": {
"description": "The code location.",
"$ref": "#/definitions/location"
},
"stack": {
"description": "The call stack leading to this location.",
"$ref": "#/definitions/stack"
},
"kinds": {
"description": "A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"type": "string"
}
},
"taxa": {
"description": "An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.",
"type": "array",
"default": [],
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/reportingDescriptorReference"
}
},
"module": {
"description": "The name of the module that contains the code that is executing.",
"type": "string"
},
"state": {
"description": "A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"nestingLevel": {
"description": "An integer representing a containment hierarchy within the thread flow.",
"type": "integer",
"minimum": 0
},
"executionOrder": {
"description": "An integer representing the temporal order in which execution reached this location.",
"type": "integer",
"default": -1,
"minimum": -1
},
"executionTimeUtc": {
"description": "The Coordinated Universal Time (UTC) date and time at which this location was executed.",
"type": "string",
"format": "date-time"
},
"importance": {
"description": "Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is \"essential\", \"important\", \"unimportant\". Default: \"important\".",
"enum": ["important", "essential", "unimportant"],
"default": "important"
},
"webRequest": {
"description": "A web request associated with this thread flow location.",
"$ref": "#/definitions/webRequest"
},
"webResponse": {
"description": "A web response associated with this thread flow location.",
"$ref": "#/definitions/webResponse"
},
"properties": {
"description": "Key/value pairs that provide additional information about the threadflow location.",
"$ref": "#/definitions/propertyBag"
}
}
},
"tool": {
"description": "The analysis tool that was run.",
"additionalProperties": false,
"type": "object",
"properties": {
"driver": {
"description": "The analysis tool that was run.",
"$ref": "#/definitions/toolComponent"
},
"extensions": {
"description": "Tool extensions that contributed to or reconfigured the analysis tool that was run.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponent"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the tool.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["driver"]
},
"toolComponent": {
"description": "A component, such as a plug-in or the driver, of the analysis tool that was run.",
"additionalProperties": false,
"type": "object",
"properties": {
"guid": {
"description": "A unique identifier for the tool component in the form of a GUID.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"name": {
"description": "The name of the tool component.",
"type": "string"
},
"organization": {
"description": "The organization or company that produced the tool component.",
"type": "string"
},
"product": {
"description": "A product suite to which the tool component belongs.",
"type": "string"
},
"productSuite": {
"description": "A localizable string containing the name of the suite of products to which the tool component belongs.",
"type": "string"
},
"shortDescription": {
"description": "A brief description of the tool component.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A comprehensive description of the tool component.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullName": {
"description": "The name of the tool component along with its version and any other useful identifying information, such as its locale.",
"type": "string"
},
"version": {
"description": "The tool component version, in whatever format the component natively provides.",
"type": "string"
},
"semanticVersion": {
"description": "The tool component version in the format specified by Semantic Versioning 2.0.",
"type": "string"
},
"dottedQuadFileVersion": {
"description": "The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).",
"type": "string",
"pattern": "[0-9]+(\\.[0-9]+){3}"
},
"releaseDateUtc": {
"description": "A string specifying the UTC date (and optionally, the time) of the component's release.",
"type": "string"
},
"downloadUri": {
"description": "The absolute URI from which the tool component can be downloaded.",
"type": "string",
"format": "uri"
},
"informationUri": {
"description": "The absolute URI at which information about this version of the tool component can be found.",
"type": "string",
"format": "uri"
},
"globalMessageStrings": {
"description": "A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/multiformatMessageString"
}
},
"notifications": {
"description": "An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"rules": {
"description": "An array of reportingDescriptor objects relevant to the analysis performed by the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"taxa": {
"description": "An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/reportingDescriptor"
}
},
"locations": {
"description": "An array of the artifactLocation objects associated with the tool component.",
"type": "array",
"minItems": 0,
"default": [],
"items": {
"$ref": "#/definitions/artifactLocation"
}
},
"language": {
"description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).",
"type": "string",
"default": "en-US",
"pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$"
},
"contents": {
"description": "The kinds of data contained in this object.",
"type": "array",
"uniqueItems": true,
"default": ["localizedData", "nonLocalizedData"],
"items": {
"enum": ["localizedData", "nonLocalizedData"]
}
},
"isComprehensive": {
"description": "Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.",
"type": "boolean",
"default": false
},
"localizedDataSemanticVersion": {
"description": "The semantic version of the localized strings defined in this component; maintained by components that provide translations.",
"type": "string"
},
"minimumRequiredLocalizedDataSemanticVersion": {
"description": "The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.",
"type": "string"
},
"associatedComponent": {
"description": "The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.",
"$ref": "#/definitions/toolComponentReference"
},
"translationMetadata": {
"description": "Translation metadata, required for a translation, not populated by other component types.",
"$ref": "#/definitions/translationMetadata"
},
"supportedTaxonomies": {
"description": "An array of toolComponentReference objects to declare the taxonomies supported by the tool component.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"default": [],
"items": {
"$ref": "#/definitions/toolComponentReference"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the tool component.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["name"]
},
"toolComponentReference": {
"description": "",
"type": "object",
"properties": {
"name": {
"description": "The 'name' property of the referenced toolComponent.",
"type": "string"
},
"index": {
"description": "An index into the referenced toolComponent in tool.extensions.",
"type": "integer",
"default": -1,
"minimum": -1
},
"guid": {
"description": "The 'guid' property of the referenced toolComponent.",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"properties": {
"description": "Key/value pairs that provide additional information about the toolComponentReference.",
"$ref": "#/definitions/propertyBag"
}
}
},
"translationMetadata": {
"description": "Provides additional metadata related to translation.",
"type": "object",
"properties": {
"name": {
"description": "The name associated with the translation metadata.",
"type": "string"
},
"fullName": {
"description": "The full name associated with the translation metadata.",
"type": "string"
},
"shortDescription": {
"description": "A brief description of the translation metadata.",
"$ref": "#/definitions/multiformatMessageString"
},
"fullDescription": {
"description": "A comprehensive description of the translation metadata.",
"$ref": "#/definitions/multiformatMessageString"
},
"downloadUri": {
"description": "The absolute URI from which the translation metadata can be downloaded.",
"type": "string",
"format": "uri"
},
"informationUri": {
"description": "The absolute URI from which information related to the translation metadata can be downloaded.",
"type": "string",
"format": "uri"
},
"properties": {
"description": "Key/value pairs that provide additional information about the translation metadata.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["name"]
},
"versionControlDetails": {
"description": "Specifies the information necessary to retrieve a desired revision from a version control system.",
"type": "object",
"additionalProperties": false,
"properties": {
"repositoryUri": {
"description": "The absolute URI of the repository.",
"type": "string",
"format": "uri"
},
"revisionId": {
"description": "A string that uniquely and permanently identifies the revision within the repository.",
"type": "string"
},
"branch": {
"description": "The name of a branch containing the revision.",
"type": "string"
},
"revisionTag": {
"description": "A tag that has been applied to the revision.",
"type": "string"
},
"asOfTimeUtc": {
"description": "A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.",
"type": "string",
"format": "date-time"
},
"mappedTo": {
"description": "The location in the local file system to which the root of the repository was mapped at the time of the analysis.",
"$ref": "#/definitions/artifactLocation"
},
"properties": {
"description": "Key/value pairs that provide additional information about the version control details.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["repositoryUri"]
},
"webRequest": {
"description": "A web request object.",
"type": "object",
"properties": {
"index": {
"description": "The index within the run.webRequests array of the request object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"protocol": {
"description": "The request protocol. Example: 'http'.",
"type": "string"
},
"version": {
"description": "The request version. Example: '1.1'.",
"type": "string"
},
"target": {
"description": "The target of the request.",
"type": "string"
},
"method": {
"description": "The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.",
"type": "string"
},
"headers": {
"description": "The request headers.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"parameters": {
"description": "The request parameters.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"description": "The body of the request.",
"$ref": "#/definitions/artifactContent"
},
"properties": {
"description": "Key/value pairs that provide additional information about the request.",
"$ref": "#/definitions/propertyBag"
}
}
},
"webResponse": {
"description": "A web response object.",
"type": "object",
"properties": {
"index": {
"description": "The index within the run.webResponses array of the response object associated with this result.",
"type": "integer",
"default": -1,
"minimum": -1
},
"protocol": {
"description": "The response protocol. Example: 'http'.",
"type": "string"
},
"version": {
"description": "The response version. Example: '1.1'.",
"type": "string"
},
"statusCode": {
"description": "The response status code. Example: 451.",
"type": "integer"
},
"reasonPhrase": {
"description": "The response reason. Example: 'Not found'.",
"type": "string"
},
"headers": {
"description": "The response headers.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"body": {
"description": "The body of the response.",
"$ref": "#/definitions/artifactContent"
},
"noResponseReceived": {
"description": "Specifies whether a response was received from the server.",
"type": "boolean",
"default": false
},
"properties": {
"description": "Key/value pairs that provide additional information about the response.",
"$ref": "#/definitions/propertyBag"
}
}
}
},
"description": "Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 JSON Schema: a standard format for the output of static analysis tools.",
"properties": {
"$schema": {
"description": "The URI of the JSON schema corresponding to the version.",
"type": "string",
"format": "uri"
},
"version": {
"description": "The SARIF format version of this log file.",
"enum": ["2.1.0"]
},
"runs": {
"description": "The set of runs contained in this log file.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": {
"$ref": "#/definitions/run"
}
},
"inlineExternalProperties": {
"description": "References to external property files that share data between runs.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"$ref": "#/definitions/externalProperties"
}
},
"properties": {
"description": "Key/value pairs that provide additional information about the log file.",
"$ref": "#/definitions/propertyBag"
}
},
"required": ["version", "runs"],
"title": "Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 JSON Schema",
"type": "object"
}
| sarif-2 |
{
"additionalProperties": false,
"description": "Context Schema for a video player event",
"properties": {
"autoPictureInPicture": {
"description": "A boolean value that is true if the video should enter or leave picture-in-picture mode automatically when changing tab and/or application",
"type": [
"boolean",
"null"
]
},
"disablePictureInPicture": {
"description": "The disablePictureInPicture property will hint the user agent to not suggest the picture-in-picture to users or to request it automatically",
"type": [
"boolean",
"null"
]
},
"poster": {
"description": "'poster' HTML attribute, which specifies an image to show while no video data is available",
"maxLength": 65535,
"type": [
"string",
"null"
]
},
"videoHeight": {
"description": "A value indicating the intrinsic height of the resource in CSS pixels, or 0 if no media is available yet",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"videoWidth": {
"description": "A value indicating the intrinsic width of the resource in CSS pixels, or 0 if no media is available yet",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"videoHeight",
"videoWidth"
],
"self": {
"format": "jsonschema",
"name": "video_element",
"vendor": "org.whatwg",
"version": "1-0-0"
},
"type": "object"
} | sp_419_Normalized |
{
"properties": {
"client_name": {
"description": "The name of the client",
"type": "string"
},
"discount": {
"description": "The discount percentage for the invoice",
"type": "number"
},
"items": {
"description": "The items and quantities for the invoice",
"items": {
"properties": {
"name": {
"description": "The name of the item",
"type": "string"
},
"price": {
"description": "The price of the item",
"type": "number"
},
"quantity": {
"description": "The quantity of the item",
"type": "integer"
}
},
"required": [
"name",
"quantity",
"price"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"client_name",
"items"
],
"type": "object"
} | generate_invoice_938a3402 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"tags": {
"type": "array",
"minItems": 2,
"maxItems": 4,
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"tags"
]
} | o81593 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"id": "https://eddn.edcd.io/schemas/outfitting/2#",
"properties": {
"$schemaRef": {
"type": "string"
},
"header": {
"additionalProperties": true,
"properties": {
"gatewayTimestamp": {
"_format": "date-time",
"description": "Timestamp upon receipt at the gateway. If present, this property will be overwritten by the gateway; submitters are not intended to populate this property.",
"type": "string"
},
"softwareName": {
"type": "string"
},
"softwareVersion": {
"type": "string"
},
"uploaderID": {
"type": "string"
}
},
"required": [
"uploaderID",
"softwareName",
"softwareVersion"
],
"type": "object"
},
"message": {
"additionalProperties": false,
"properties": {
"horizons": {
"description": "Whether the sending Cmdr has a Horizons pass.",
"type": "boolean"
},
"marketId": {
"type": "number"
},
"modules": {
"items": {
"description": "Module symbolic name. e.g. Hpt_ChaffLauncher_Tiny, Int_Engine_Size3_Class5_Fast, Independant_Trader_Armour_Grade1, etc. Modules that depend on the Cmdr's purchases (e.g. bobbleheads, paintjobs) or rank (e.g. decals and PowerPlay faction-specific modules) should be omitted.",
"minLength": 1,
"pattern": "(^Hpt_|^Int_|_Armour_)",
"type": "string"
},
"minItems": 1,
"type": "array",
"_uniqueItems": true
},
"stationName": {
"minLength": 1,
"type": "string"
},
"systemName": {
"minLength": 1,
"type": "string"
},
"timestamp": {
"_format": "date-time",
"type": "string"
}
},
"required": [
"systemName",
"stationName",
"marketId",
"timestamp",
"modules"
],
"type": "object"
}
},
"required": [
"$schemaRef",
"header",
"message"
],
"type": "object"
} | o4180 |
{
"properties": {
"dimensions": {
"description": "The dimensions specific to the shape",
"properties": {
"length": {
"description": "The length of the shape",
"type": "number"
},
"radius": {
"description": "The radius of the shape",
"type": "number"
},
"width": {
"description": "The width of the shape",
"type": "number"
}
},
"required": [
"length",
"width",
"radius"
],
"type": "object"
},
"shape": {
"description": "The type of shape (e.g. square, rectangle, circle)",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_212285ec |
{
"additionalProperties": false,
"description": "An add_to_wishlist GTM server-side event.",
"properties": {
"currency": {
"description": "Currency of the items associated with the event, in 3-letter ISO 4217 format. Is required, if value is set.",
"maxLength": 3,
"minLength": 3,
"type": [
"string",
"null"
]
},
"items": {
"description": "The items for the event.",
"items": {
"additionalProperties": false,
"description": "An item object.",
"properties": {
"affiliation": {
"description": "A product affiliation to designate a supplying company or brick and mortar store location",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"coupon": {
"description": "The coupon name or code associated with the item.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"currency": {
"description": "The currency, in 3-letter ISO 4217 format.",
"maxLength": 3,
"minLength": 3,
"type": [
"string",
"null"
]
},
"discount": {
"description": "The monetary discount value associated with the item.",
"minimum": 0,
"type": [
"number",
"null"
]
},
"index": {
"description": "The index of the item in a list.",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"item_brand": {
"description": "The brand of the item.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"item_category": {
"description": "The category of the item.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"item_category2": {
"description": "The second category hierarchy or additional taxonomy for the item.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"item_category3": {
"description": "The third category hierarchy or additional taxonomy for the item.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"item_category4": {
"description": "The fourth category hierarchy or additional taxonomy for the item.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"item_category5": {
"description": "The fifth category hierarchy or additional taxonomy for the item.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"item_id": {
"description": "The ID of the item.",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"item_list_id": {
"description": "The ID of the list in which the item was presented to the user.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"item_list_name": {
"description": "The name of the list in which the item was presented to the user.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"item_name": {
"description": "The name of the item.",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"item_variant": {
"description": "The item variant or unique code or description for additional item details or options.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"location_id": {
"description": "The location associated with the item.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
"price": {
"description": "The monetary price of the item, in units of the specified currency parameter.",
"minimum": 0,
"type": [
"number",
"null"
]
},
"quantity": {
"description": "Item quantity.",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"type": "object"
},
"type": "array"
},
"value": {
"description": "The monetary value of the event.",
"minimum": 0,
"type": [
"number",
"null"
]
}
},
"required": [
"items"
],
"self": {
"format": "jsonschema",
"name": "add_to_wishlist",
"vendor": "com.google.tag-manager.server-side",
"version": "1-0-0"
},
"type": "object"
} | sp_81_Normalized |
{
"title": "lod",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"properties": {
"level": {
"type": "integer",
"description": "ID for each level."
},
"levelValue": {
"type": "string",
"description": "String to be used when constructing URL to access a tile from this LOD."
},
"resolution": {
"type": "number",
"description": "Resolution in map units of each pixel in a tile for each level."
},
"scale": {
"type": "number",
"description": "Scale for each level."
}
},
"additionalProperties": false
} | o90234 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Service 002 : DELETE /users/",
"description": "Delete users listed from a list of ids",
"type": "array",
"items": {
"description": "the list results",
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"SUCCESS",
"ERROR"
]
}
},
"required": [
"id",
"status"
]
}
} | o64535 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Event source templates",
"description": "The collection of event source templates",
"type": "array",
"items": {
"description": "Event source templates.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier given by the server",
"type": "integer"
},
"key": {
"description": "Unique key generated by the server to be used in events.",
"type": "string"
},
"name": {
"description": "A name to identify the event source template",
"type": "string"
},
"public": {
"description": "Make the event source template available to everybody.",
"type": "boolean"
},
"organizationId": {
"description": "The organization that offer the event source template.",
"type": "integer"
},
"configuration": {
"description": "Providing a schema aims to help the WUI for configuration.",
"type": "object",
"properties": {
"schema": {
"description": "A valid JSON Schema.",
"type": "object"
},
"url": {
"description": "The configuration URL.",
"type": "string"
},
"token": {
"description": "JSON Web Token to be authenticated when contacting the configuration URL.",
"type": "string"
}
},
"required": [
"schema",
"url"
]
},
"configurationUi": {
"description": "Provide the configuration for the dynamic UI.",
"type": "object",
"properties": {
"schemaForm": {
"description": "Valid form schema accordingly to: http://schemaform.io",
"type": "array"
}
}
}
},
"required": [
"id",
"key",
"name",
"public",
"organizationId"
]
}
}
| o14474 |
{
"description": "APIResource specifies the name of a resource and whether it is namespaced.",
"properties": {
"categories": {
"description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"group": {
"description": "group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\".",
"type": [
"string",
"null"
]
},
"kind": {
"description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
"type": [
"string",
"null"
]
},
"name": {
"description": "name is the plural name of the resource.",
"type": [
"string",
"null"
]
},
"namespaced": {
"description": "namespaced indicates if a resource is namespaced or not.",
"type": [
"boolean",
"null"
]
},
"shortNames": {
"description": "shortNames is a list of suggested short names of the resource.",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"singularName": {
"description": "singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.",
"type": [
"string",
"null"
]
},
"storageVersionHash": {
"description": "The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.",
"type": [
"string",
"null"
]
},
"verbs": {
"description": "verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)",
"items": {
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
]
},
"version": {
"description": "version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)\".",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"singularName",
"namespaced",
"kind",
"verbs"
],
"type": "object"
} | kb_20_Normalized |
{
"properties": {
"dimensions": {
"properties": {
"base": {
"description": "The base of the triangle",
"type": "number"
},
"height": {
"description": "The height of the triangle",
"type": "number"
},
"length": {
"description": "The length of the rectangle",
"type": "number"
},
"radius": {
"description": "The radius of the circle",
"type": "number"
},
"width": {
"description": "The width of the rectangle",
"type": "number"
}
},
"required": [
"radius",
"length",
"width",
"base",
"height"
],
"type": "object"
},
"shape": {
"description": "The shape for which area needs to be calculated",
"enum": [
"circle",
"rectangle",
"triangle"
],
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_4c3f5d87 |
{
"properties": {
"point1": {
"properties": {
"latitude": {
"description": "The latitude of the first point",
"type": "number"
},
"longitude": {
"description": "The longitude of the first point",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"point2": {
"properties": {
"latitude": {
"description": "The latitude of the second point",
"type": "number"
},
"longitude": {
"description": "The longitude of the second point",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
},
"unit": {
"description": "The unit of distance",
"enum": [
"km",
"miles"
],
"type": "string"
}
},
"required": [
"point1",
"point2"
],
"type": "object"
} | calculate_distance_444a6c19 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "IntersectionType",
"description": "",
"type": "object",
"properties": {
"foobar": {
"allOf": [
{
"type": "object",
"properties": {
"foo": {
"type": "string"
}
},
"required": [
"foo"
]
},
{
"type": "object",
"properties": {
"bar": {
"type": "string"
}
},
"required": [
"bar"
]
}
]
}
},
"additionalProperties": false,
"required": [
"foobar"
]
} | o75594 |
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$id": "https://raw.githubusercontent.com/actions-on-google/assistant-conversation-schema/master/conversation.json#",
"title": "Actions SDK Fulfillment Conversational V3 Schema",
"definitions": {
"HandlerRequest": {
"description": "Represents a request sent to a developer's fulfillment by Google.",
"type": "object",
"properties": {
"handler": {
"description": "Required. Information to fulfillment on how to handle the request. For\nexample a request intending to get a fact might have a handler with a name\nof \"getFact\".",
"$ref": "#/definitions/Handler"
},
"intent": {
"description": "Required. Represents the last matched intent.",
"$ref": "#/definitions/Intent"
},
"scene": {
"description": "Optional. Info on the current and next scene when the function was called.\nWill be filled when the fulfillment call is made\nwithin the scope of a scene.",
"$ref": "#/definitions/Scene"
},
"session": {
"description": "Required. Holds session data like the session id and session parameters.",
"$ref": "#/definitions/Session"
},
"user": {
"description": "Required. User who initiated the conversation.",
"$ref": "#/definitions/User"
},
"home": {
"description": "Optional. Information related to the HomeGraph structure that the target device\nbelongs to. See\nhttps://developers.google.com/actions/smarthome/concepts/homegraph.",
"$ref": "#/definitions/Home"
},
"device": {
"description": "Required. Info on the device the user is using to interact with the Action.",
"$ref": "#/definitions/Device"
},
"context": {
"description": "Optional. Information of current context of the request. Includes but isn't limited\nto active media session info or canvas info.",
"$ref": "#/definitions/Context"
}
}
},
"Handler": {
"description": "Represents a fulfillment handler that maps event information\nfrom Actions on Google to fulfillment. Use the handler name to determine what\ncode you should run in fulfillment. For instance, a handler might be\nused to get information on a user's order information with a handler name\nlike \"OrderLookup\" while another might get product information from a\ndatabase, with a handler name like \"GetProductInfo\".",
"type": "object",
"properties": {
"name": {
"description": "Optional. The name of the handler.",
"type": "string"
}
}
},
"Intent": {
"description": "Represents an intent.",
"type": "object",
"properties": {
"name": {
"description": "Required. The name of the last matched intent.",
"type": "string"
},
"params": {
"description": "Required. Represents parameters identified as part of intent matching.\nThis is a map of the name of the identified parameter to the value of the\nparameter identified from user input. All parameters defined in\nthe matched intent that are identified will be surfaced here.",
"type": "object"
},
"query": {
"description": "Optional. Typed or spoken input from the end user that matched this intent.\nThis will be populated when an intent is matched, based on the user input.",
"type": "string"
}
}
},
"IntentParameterValue": {
"description": "Represents a value for intent parameter.",
"type": "object",
"properties": {
"original": {
"description": "Required. Original text value extracted from user utterance.",
"type": "string"
},
"resolved": {
"description": "Required. Structured value for parameter extracted from user input.\nThis will only be populated if the parameter is defined in the matched\nintent and the value of the parameter could be identified during intent\nmatching."
}
}
},
"Scene": {
"description": "Represent a scene. Scenes can call fulfillment, add prompts, and collect slot\nvalues from the user. Scenes are triggered by events or intents and can\ntrigger events and match intents to transition to other scenes.",
"type": "object",
"properties": {
"name": {
"description": "Required. Name of the current scene.",
"type": "string"
},
"slotFillingStatus": {
"description": "Required. The current status of slot filling. This field is read-only.",
"type": "string",
"enum": [
"UNSPECIFIED",
"INITIALIZED",
"COLLECTING",
"FINALIZING",
"FINAL"
]
},
"slots": {
"description": "The slots associated with the current scene. Handler responses cannot\nreturn slots which were not sent in the request.",
"type": "object"
},
"next": {
"description": "Optional. Information on the scene to be executed next.",
"$ref": "#/definitions/NextScene"
}
}
},
"Slot": {
"description": "Represents a slot.",
"type": "object",
"properties": {
"mode": {
"description": "The mode of the slot (required or optional). Can be set by developer.",
"type": "string",
"enum": [
"MODE_UNSPECIFIED",
"OPTIONAL",
"REQUIRED"
]
},
"status": {
"description": "The status of the slot.",
"type": "string",
"enum": [
"SLOT_UNSPECIFIED",
"EMPTY",
"INVALID",
"FILLED"
]
},
"value": {
"description": "The value of the slot. Changing this value in the response, will\nmodify the value in slot filling."
},
"updated": {
"description": "Indicates if the slot value was collected on the last turn.\nThis field is read-only.",
"type": "boolean"
},
"prompt": {
"description": "Optional. This prompt is sent to the user when needed to fill a required\nslot. This prompt overrides the existing prompt defined in the console.\nThis field is not included in the webhook request.",
"$ref": "#/definitions/Prompt"
}
}
},
"Prompt": {
"description": "Represent a response to a user.",
"type": "object",
"properties": {
"override": {
"description": "Optional. Mode for how this messages should be merged with previously\ndefined messages.\n\"true\" clears all previously defined messages (first and last\nsimple, content, suggestions link and canvas) and adds messages defined in\nthis prompt.\n\"false\" adds messages defined in this prompt to messages defined in\nprevious responses. Leaving this field to \"false\" also enables\nappending to some fields inside Simple prompts, the Suggestions prompt,\nand the Canvas prompt (part of the Content prompt). The Content and Link\nmessages are always overwritten if defined in the prompt. Default\nvalue is \"false\".",
"type": "boolean"
},
"firstSimple": {
"description": "Optional. The first voice and text-only response.",
"$ref": "#/definitions/Simple"
},
"content": {
"description": "Optional. A content like a card, list or media to display to the user.",
"$ref": "#/definitions/Content"
},
"lastSimple": {
"description": "Optional. The last voice and text-only response.",
"$ref": "#/definitions/Simple"
},
"suggestions": {
"description": "Optional. Suggestions to be displayed to the user which will always appear\nat the end of the response.\nIf the \"override\" field in the containing prompt is \"false\", the titles\ndefined in this field will be added to titles defined in any previously\ndefined suggestions prompts and duplicate values will be removed.",
"type": "array",
"items": {
"$ref": "#/definitions/Suggestion"
}
},
"link": {
"description": "Optional. An additional suggestion chip that can link out to the associated app\nor site.\nThe chip will be rendered with the title \"Open <name>\". Max 20 chars.",
"$ref": "#/definitions/Link"
},
"canvas": {
"description": "Optional. Represents a Interactive Canvas response to be sent to the user.",
"$ref": "#/definitions/Canvas"
},
"orderUpdate": {
"description": "Optional\nAction responds with an OrderUpdate after receiving the order during the\ntransactions flow. On receipt of this, Google records this update to the\norder, and if successful, displays a receipt card along with the TTS sent\non display devices.",
"$ref": "#/definitions/OrderUpdate"
}
}
},
"Simple": {
"description": "Represents a simple prompt to be send to a user.",
"type": "object",
"properties": {
"speech": {
"description": "Optional. Represents the speech to be spoken to the user. Can be SSML or\ntext to speech.\nIf the \"override\" field in the containing prompt is \"true\", the speech\ndefined in this field replaces the previous Simple prompt's speech.",
"type": "string"
},
"text": {
"description": "Optional text to display in the chat bubble. If not given, a display\nrendering of the speech field above will be used. Limited to 640\nchars.\nIf the \"override\" field in the containing prompt is \"true\", the text\ndefined in this field replaces to the previous Simple prompt's text.",
"type": "string"
}
}
},
"Content": {
"type": "object",
"properties": {
"card": {
"description": "A basic card.",
"$ref": "#/definitions/Card"
},
"image": {
"description": "An image.",
"$ref": "#/definitions/Image"
},
"table": {
"description": "Table card.",
"$ref": "#/definitions/Table"
},
"media": {
"description": "Response indicating a set of media to be played.",
"$ref": "#/definitions/Media"
},
"collection": {
"description": "A card presenting a collection of options to select from.",
"$ref": "#/definitions/Collection"
},
"list": {
"description": "A card presenting a list of options to select from.",
"$ref": "#/definitions/List"
}
}
},
"Card": {
"description": "A basic card for displaying some information, e.g. an image and/or text.",
"type": "object",
"properties": {
"title": {
"description": "Overall title of the card.\nOptional.",
"type": "string"
},
"subtitle": {
"description": "Optional.",
"type": "string"
},
"text": {
"description": "Body text of the card.\nSupports a limited set of markdown syntax for formatting.\nRequired, unless image is present.",
"type": "string"
},
"image": {
"description": "A hero image for the card. The height is fixed to 192dp.\nOptional.",
"$ref": "#/definitions/Image"
},
"imageFill": {
"description": "How the image background will be filled. Optional.",
"type": "string",
"enum": [
"UNSPECIFIED",
"GRAY",
"WHITE",
"CROPPED"
]
},
"button": {
"description": "Button.\nOptional.",
"$ref": "#/definitions/Link"
}
}
},
"Image": {
"description": "An image displayed in the card.",
"type": "object",
"properties": {
"url": {
"description": "The source url of the image. Images can be JPG, PNG and GIF (animated and\nnon-animated). For example,`https://www.agentx.com/logo.png`. Required.",
"type": "string"
},
"alt": {
"description": "A text description of the image to be used for accessibility, e.g. screen\nreaders.\nRequired.",
"type": "string"
},
"height": {
"description": "The height of the image in pixels.\nOptional.",
"type": "integer",
"format": "int32"
},
"width": {
"description": "The width of the image in pixels.\nOptional.",
"type": "integer",
"format": "int32"
}
}
},
"Link": {
"type": "object",
"properties": {
"name": {
"description": "Name of the link",
"type": "string"
},
"open": {
"description": "What happens when a user opens the link",
"$ref": "#/definitions/OpenUrl"
}
}
},
"OpenUrl": {
"type": "object",
"properties": {
"url": {
"description": "The url field which could be any of:\n- http/https urls for opening an App-linked App or a webpage",
"type": "string"
},
"hint": {
"description": "Indicates a hint for the url type.",
"type": "string",
"enum": [
"LINK_UNSPECIFIED",
"AMP"
]
}
}
},
"Table": {
"description": "A table card for displaying a table of text.",
"type": "object",
"properties": {
"title": {
"description": "Overall title of the table. Optional but must be set if subtitle is set.",
"type": "string"
},
"subtitle": {
"description": "Subtitle for the table. Optional.",
"type": "string"
},
"image": {
"description": "Image associated with the table. Optional.",
"$ref": "#/definitions/Image"
},
"columns": {
"description": "Headers and alignment of columns.",
"type": "array",
"items": {
"$ref": "#/definitions/TableColumn"
}
},
"rows": {
"description": "Row data of the table. The first 3 rows are guaranteed to be shown but\nothers might be cut on certain surfaces. Please test with the simulator to\nsee which rows will be shown for a given surface. On surfaces that support\nthe WEB_BROWSER capability, you can point the user to\na web page with more data.",
"type": "array",
"items": {
"$ref": "#/definitions/TableRow"
}
},
"button": {
"description": "Button.",
"$ref": "#/definitions/Link"
}
}
},
"TableColumn": {
"type": "object",
"properties": {
"header": {
"description": "Header text for the column.",
"type": "string"
},
"align": {
"description": "Horizontal alignment of content w.r.t column. If unspecified, content\nwill be aligned to the leading edge.",
"type": "string",
"enum": [
"UNSPECIFIED",
"LEADING",
"CENTER",
"TRAILING"
]
}
}
},
"TableRow": {
"description": "Describes a row in the table.",
"type": "object",
"properties": {
"cells": {
"description": "Cells in this row. The first 3 cells are guaranteed to be shown but\nothers might be cut on certain surfaces. Please test with the simulator\nto see which cells will be shown for a given surface.",
"type": "array",
"items": {
"$ref": "#/definitions/TableCell"
}
},
"divider": {
"description": "Indicates whether there should be a divider after each row.",
"type": "boolean"
}
}
},
"TableCell": {
"description": "Describes a cell in a row.",
"type": "object",
"properties": {
"text": {
"description": "Text content of the cell.",
"type": "string"
}
}
},
"Media": {
"description": "Represents one media object.\nContains information about the media, such as name, description, url, etc.",
"type": "object",
"properties": {
"mediaType": {
"type": "string",
"enum": [
"MEDIA_TYPE_UNSPECIFIED",
"AUDIO",
"MEDIA_STATUS_ACK"
]
},
"startOffset": {
"description": "Start offset of the first media object.",
"type": "string",
"format": "google-duration"
},
"optionalMediaControls": {
"description": "Optional media control types this media response session can support.\nIf set, request will be made to 3p when a certain media event happens.\nIf not set, 3p must still handle two default control type, FINISHED and\nFAILED.",
"type": "array",
"items": {
"type": "string",
"enum": [
"OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED",
"PAUSED",
"STOPPED"
]
}
},
"mediaObjects": {
"description": "List of Media Objects",
"type": "array",
"items": {
"$ref": "#/definitions/MediaObject"
}
}
}
},
"MediaObject": {
"description": "Represents a single media object",
"type": "object",
"properties": {
"name": {
"description": "Name of this media object.",
"type": "string"
},
"description": {
"description": "Description of this media object.",
"type": "string"
},
"url": {
"description": "The url pointing to the media content.",
"type": "string"
},
"image": {
"description": "Image to show with the media card.",
"$ref": "#/definitions/MediaImage"
}
}
},
"MediaImage": {
"type": "object",
"properties": {
"large": {
"description": "A large image, such as the cover of the album, etc.",
"$ref": "#/definitions/Image"
},
"icon": {
"description": "A small image icon displayed on the right from the title.\nIt's resized to 36x36 dp.",
"$ref": "#/definitions/Image"
}
}
},
"Collection": {
"description": "A card for presenting a collection of options to select from.",
"type": "object",
"properties": {
"title": {
"description": "Title of the collection. Optional.",
"type": "string"
},
"subtitle": {
"description": "Subtitle of the collection. Optional.",
"type": "string"
},
"items": {
"description": "min: 2 max: 10",
"type": "array",
"items": {
"$ref": "#/definitions/CollectionItem"
}
},
"imageFill": {
"description": "How the image backgrounds of collection items will be filled. Optional.",
"type": "string",
"enum": [
"UNSPECIFIED",
"GRAY",
"WHITE",
"CROPPED"
]
}
}
},
"CollectionItem": {
"description": "An item in the collection",
"type": "object",
"properties": {
"key": {
"description": "Required. The NLU key that matches the entry key name in the associated\nType.",
"type": "string"
}
}
},
"List": {
"description": "A card for presenting a list of options to select from.",
"type": "object",
"properties": {
"title": {
"description": "Title of the list. Optional.",
"type": "string"
},
"subtitle": {
"description": "Subtitle of the list. Optional.",
"type": "string"
},
"items": {
"description": "min: 2 max: 30",
"type": "array",
"items": {
"$ref": "#/definitions/ListItem"
}
}
}
},
"ListItem": {
"description": "An item in the list",
"type": "object",
"properties": {
"key": {
"description": "Required. The NLU key that matches the entry key name in the associated\nType.",
"type": "string"
}
}
},
"Suggestion": {
"type": "object",
"properties": {
"title": {
"description": "Required. The text shown in the suggestion chip. When tapped, this text will be\nposted back to the conversation verbatim as if the user had typed it.\nEach title must be unique among the set of suggestion chips.\nMax 25 chars",
"type": "string"
}
}
},
"Canvas": {
"description": "Represents an Interactive Canvas response to be sent to the user.\nThis can be used in conjunction with the \"first_simple\" field in the\ncontaining prompt to speak to the user in addition to displaying a\ninteractive canvas response. The maximum size of the response is 50k bytes.",
"type": "object",
"properties": {
"url": {
"description": "URL of the interactive canvas web app to load. If not set, the url from\ncurrent active canvas will be reused.",
"type": "string"
},
"data": {
"description": "Optional. JSON data to be passed through to the immersive experience\nweb page as an event.\nIf the \"override\" field in the containing prompt is \"false\" data values\ndefined in this Canvas prompt will be added after data values defined in\nprevious Canvas prompts.",
"type": "array"
},
"suppressMic": {
"description": "Optional. Default value: false.",
"type": "boolean"
}
}
},
"OrderUpdate": {
"description": "Update to an order.",
"type": "object",
"properties": {
"type": {
"description": "Deprecated: Use OrderUpdate.update_mask instead.\nIf type = SNAPSHOT, OrderUpdate.order should be the entire order.\nIf type = ORDER_STATUS, this is the order level status change. Only\norder.last_update_time and this vertical status are picked up.\nNote: type.ORDER_STATUS only supports PurcahaseOrderExtension status\nupdates and there is no plan to extend this support. Instead, we recommend\nusing update_mask as it is more generic, extensible and can be used for all\nverticals.",
"type": "string",
"enum": [
"TYPE_UNSPECIFIED",
"ORDER_STATUS",
"SNAPSHOT"
]
},
"order": {
"$ref": "#/definitions/Order"
},
"updateMask": {
"description": "Note: There are following consideration/recommendations for following\nspecial fields:\n1. order.last_update_time will always be updated as part of the update\nrequest.\n2. order.create_time, order.google_order_id and order.merchant_order_id\nwill be ignored if provided as part of the update_mask.",
"type": "string",
"format": "google-fieldmask"
},
"userNotification": {
"description": "If specified, displays a notification to the user with the specified\ntitle and text. Specifying a notification is a suggestion to\nnotify and is not guaranteed to result in a notification.",
"$ref": "#/definitions/UserNotification"
},
"reason": {
"description": "Reason for the change/update.",
"type": "string"
}
}
},
"Order": {
"description": "Order entity.\nNote:\n1. All strings at all levels must be less than 1000 chars unless otherwise\nspecified.\n2. All repeated fields at all levels must be less than 50 in count unless\notherwise specified.\n3. All timestamps at all levels, if specified, must be valid timestamps.",
"type": "object",
"properties": {
"googleOrderId": {
"description": "Google assigned order id.",
"type": "string"
},
"merchantOrderId": {
"description": "Required: Merchant assigned internal order id. This id must be unique, and\nis required for subsequent order update operations. This id may be set to\nthe provided google_order_id, or any other unique value. Note that the id\npresented to users is the user_visible_order_id, which may be a different,\nmore user-friendly value.\nMax allowed length is 128 chars.",
"type": "string"
},
"userVisibleOrderId": {
"description": "The user facing id referencing to current order. This id should be\nconsistent with the id displayed for this order in other contexts,\nincluding websites, apps and email.",
"type": "string"
},
"userVisibleStateLabel": {
"description": "Deprecated: Use OrderExtensions status instead.\nUser visible label for the state of this order.",
"type": "string"
},
"buyerInfo": {
"description": "Info about the buyer.",
"$ref": "#/definitions/UserInfo"
},
"image": {
"description": "Image associated with the order.",
"$ref": "#/definitions/V2UiElementsImage"
},
"createTime": {
"description": "Required: Date and time the order was created.",
"type": "string",
"format": "google-datetime"
},
"lastUpdateTime": {
"description": "Date and time the order was last updated.\nRequired for OrderUpdate.",
"type": "string",
"format": "google-datetime"
},
"transactionMerchant": {
"description": "Merchant that facilitated the checkout. This could be different from\na line item level provider. Example: Expedia Order with line item from ANA.",
"$ref": "#/definitions/Merchant"
},
"contents": {
"description": "Required: Order contents which is a group of line items.",
"$ref": "#/definitions/Contents"
},
"priceAttributes": {
"description": "Price, discounts, taxes and so on.",
"type": "array",
"items": {
"$ref": "#/definitions/PriceAttribute"
}
},
"followUpActions": {
"description": "Follow up actions at order level.",
"type": "array",
"items": {
"$ref": "#/definitions/Action"
}
},
"paymentData": {
"description": "Payment related data for the order.",
"$ref": "#/definitions/PaymentData"
},
"termsOfServiceUrl": {
"description": "A link to the terms of service that apply to order/proposed order.",
"type": "string"
},
"note": {
"description": "Notes attached to an order.",
"type": "string"
},
"promotions": {
"description": "All promotions that are associated with this order.",
"type": "array",
"items": {
"$ref": "#/definitions/Promotion"
}
},
"disclosures": {
"description": "Disclosures associated with this order.",
"type": "array",
"items": {
"$ref": "#/definitions/Disclosure"
}
},
"purchase": {
"description": "Purchase order",
"$ref": "#/definitions/PurchasePurchaseOrderExtension"
},
"ticket": {
"description": "Ticket order",
"$ref": "#/definitions/TicketTicketOrderExtension"
},
"vertical": {
"description": "Deprecated: Use verticals instead.\nThese properties will apply to all line items, unless overridden in\nsome line item. This vertical must match the line item level vertical type.\nPossible values:\ngoogle.actions.orders.v3.verticals.purchase.PurchaseOrderExtension\ngoogle.actions.orders.v3.verticals.ticket.TicketOrderExtension",
"type": "object"
}
}
},
"UserInfo": {
"description": "Information about user. This is used to represent information of the user\nassociated with an order.",
"type": "object",
"properties": {
"email": {
"description": "User email, Eg: [email protected].",
"type": "string"
},
"firstName": {
"description": "First name of the user.",
"type": "string"
},
"lastName": {
"description": "Last name of the user.",
"type": "string"
},
"displayName": {
"description": "Display name of the user, might be different from first or last name.",
"type": "string"
},
"phoneNumbers": {
"description": "Phone numbers of the user.",
"type": "array",
"items": {
"$ref": "#/definitions/PhoneNumber"
}
}
}
},
"PhoneNumber": {
"description": "Standard phone number representation.",
"type": "object",
"properties": {
"e164PhoneNumber": {
"description": "Phone number in E.164 format, as defined in International\nTelecommunication Union (ITU) Recommendation E.164.\nwiki link: https://en.wikipedia.org/wiki/E.164",
"type": "string"
},
"extension": {
"description": "Extension is not standardized in ITU recommendations, except for being\ndefined as a series of numbers with a maximum length of 40 digits. It is\ndefined as a string here to accommodate for the possible use of a leading\nzero in the extension (organizations have complete freedom to do so, as\nthere is no standard defined). Other than digits, some other dialling\ncharacters such as \",\" (indicating a wait) may be stored here.\nFor example, in xxx-xxx-xxxx ext. 123, \"123\" is the extension.",
"type": "string"
},
"preferredDomesticCarrierCode": {
"description": "The carrier selection code that is preferred when calling this phone number\ndomestically. This also includes codes that need to be dialed in some\ncountries when calling from landlines to mobiles or vice versa. For\nexample, in Columbia, a \"3\" needs to be dialed before the phone number\nitself when calling from a mobile phone to a domestic landline phone and\nvice versa. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia\nhttps://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code\n\nNote this is the \"preferred\" code, which means other codes may work as\nwell.",
"type": "string"
}
}
},
"V2UiElementsImage": {
"description": "An image displayed in the card.",
"type": "object",
"properties": {
"url": {
"description": "The source url of the image. Images can be JPG, PNG and GIF (animated and\nnon-animated). For example,`https://www.agentx.com/logo.png`. Required.",
"type": "string"
},
"accessibilityText": {
"description": "A text description of the image to be used for accessibility, e.g. screen\nreaders.\nRequired.",
"type": "string"
},
"height": {
"description": "The height of the image in pixels.\nOptional.",
"type": "integer",
"format": "int32"
},
"width": {
"description": "The width of the image in pixels.\nOptional.",
"type": "integer",
"format": "int32"
}
}
},
"Merchant": {
"description": "Merchant for the cart/order/line item.",
"type": "object",
"properties": {
"id": {
"description": "Optional ID assigned to merchant if any.",
"type": "string"
},
"name": {
"description": "The name of the merchant like \"Panera Bread\".",
"type": "string"
},
"image": {
"description": "The image associated with the merchant.",
"$ref": "#/definitions/V2UiElementsImage"
},
"phoneNumbers": {
"description": "Merchant's phone numbers.",
"type": "array",
"items": {
"$ref": "#/definitions/PhoneNumber"
}
},
"address": {
"description": "Merchant's address.",
"$ref": "#/definitions/V2Location"
}
}
},
"V2Location": {
"description": "Container that represents a location.",
"type": "object",
"properties": {
"coordinates": {
"description": "Geo coordinates.\nRequires the DEVICE_PRECISE_LOCATION permission.",
"$ref": "#/definitions/LatLng"
},
"formattedAddress": {
"description": "Display address, e.g., \"1600 Amphitheatre Pkwy, Mountain View, CA 94043\".\nRequires the DEVICE_PRECISE_LOCATION permission.",
"type": "string"
},
"zipCode": {
"description": "Zip code.\nRequires the DEVICE_PRECISE_LOCATION or\nDEVICE_COARSE_LOCATION permission.",
"type": "string"
},
"city": {
"description": "City.\nRequires the DEVICE_PRECISE_LOCATION or\nDEVICE_COARSE_LOCATION permission.",
"type": "string"
},
"postalAddress": {
"description": "Postal address.\nRequires the DEVICE_PRECISE_LOCATION or\nDEVICE_COARSE_LOCATION permission.",
"$ref": "#/definitions/PostalAddress"
},
"name": {
"description": "Name of the place.",
"type": "string"
},
"phoneNumber": {
"description": "Phone number of the location, e.g. contact number of business location or\nphone number for delivery location.",
"type": "string"
},
"notes": {
"description": "Notes about the location.",
"type": "string"
},
"placeId": {
"description": "place_id is used with Places API to fetch details of a place.\nSee https://developers.google.com/places/web-service/place-id",
"type": "string"
}
}
},
"LatLng": {
"description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values must be within normalized ranges.",
"type": "object",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"type": "number",
"format": "double"
},
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"type": "number",
"format": "double"
}
}
},
"PostalAddress": {
"description": "Represents a postal address, e.g. for postal delivery or payments addresses.\nGiven a postal address, a postal service can deliver items to a premise, P.O.\nBox or similar.\nIt is not intended to model geographical locations (roads, towns,\nmountains).\n\nIn typical usage an address would be created via user input or from importing\nexisting data, depending on the type of process.\n\nAdvice on address input / editing:\n - Use an i18n-ready address widget such as\n https://github.com/google/libaddressinput)\n- Users should not be presented with UI elements for input or editing of\n fields outside countries where that field is used.\n\nFor more guidance on how to use this schema, please see:\nhttps://support.google.com/business/answer/6397478",
"type": "object",
"properties": {
"revision": {
"description": "The schema revision of the `PostalAddress`. This must be set to 0, which is\nthe latest revision.\n\nAll new revisions **must** be backward compatible with old revisions.",
"type": "integer",
"format": "int32"
},
"regionCode": {
"description": "Required. CLDR region code of the country/region of the address. This\nis never inferred and it is up to the user to ensure the value is\ncorrect. See http://cldr.unicode.org/ and\nhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html\nfor details. Example: \"CH\" for Switzerland.",
"type": "string"
},
"languageCode": {
"description": "Optional. BCP-47 language code of the contents of this address (if\nknown). This is often the UI language of the input form or is expected\nto match one of the languages used in the address' country/region, or their\ntransliterated equivalents.\nThis can affect formatting in certain countries, but is not critical\nto the correctness of the data and will never affect any validation or\nother non-formatting related operations.\n\nIf this value is not known, it should be omitted (rather than specifying a\npossibly incorrect default).\n\nExamples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".",
"type": "string"
},
"postalCode": {
"description": "Optional. Postal code of the address. Not all countries use or require\npostal codes to be present, but where they are used, they may trigger\nadditional validation with other parts of the address (e.g. state/zip\nvalidation in the U.S.A.).",
"type": "string"
},
"sortingCode": {
"description": "Optional. Additional, country-specific, sorting code. This is not used\nin most regions. Where it is used, the value is either a string like\n\"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number\nalone, representing the \"sector code\" (Jamaica), \"delivery area indicator\"\n(Malawi) or \"post office indicator\" (e.g. C\u00f4te d'Ivoire).",
"type": "string"
},
"administrativeArea": {
"description": "Optional. Highest administrative subdivision which is used for postal\naddresses of a country or region.\nFor example, this can be a state, a province, an oblast, or a prefecture.\nSpecifically, for Spain this is the province and not the autonomous\ncommunity (e.g. \"Barcelona\" and not \"Catalonia\").\nMany countries don't use an administrative area in postal addresses. E.g.\nin Switzerland this should be left unpopulated.",
"type": "string"
},
"locality": {
"description": "Optional. Generally refers to the city/town portion of the address.\nExamples: US city, IT comune, UK post town.\nIn regions of the world where localities are not well defined or do not fit\ninto this structure well, leave locality empty and use address_lines.",
"type": "string"
},
"sublocality": {
"description": "Optional. Sublocality of the address.\nFor example, this can be neighborhoods, boroughs, districts.",
"type": "string"
},
"addressLines": {
"description": "Unstructured address lines describing the lower levels of an address.\n\nBecause values in address_lines do not have type information and may\nsometimes contain multiple values in a single field (e.g.\n\"Austin, TX\"), it is important that the line order is clear. The order of\naddress lines should be \"envelope order\" for the country/region of the\naddress. In places where this can vary (e.g. Japan), address_language is\nused to make it explicit (e.g. \"ja\" for large-to-small ordering and\n\"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of\nan address can be selected based on the language.\n\nThe minimum permitted structural representation of an address consists\nof a region_code with all remaining information placed in the\naddress_lines. It would be possible to format such an address very\napproximately without geocoding, but no semantic reasoning could be\nmade about any of the address components until it was at least\npartially resolved.\n\nCreating an address only containing a region_code and address_lines, and\nthen geocoding is the recommended way to handle completely unstructured\naddresses (as opposed to guessing which parts of the address should be\nlocalities or administrative areas).",
"type": "array",
"items": {
"type": "string"
}
},
"recipients": {
"description": "Optional. The recipient at the address.\nThis field may, under certain circumstances, contain multiline information.\nFor example, it might contain \"care of\" information.",
"type": "array",
"items": {
"type": "string"
}
},
"organization": {
"description": "Optional. The name of the organization at the address.",
"type": "string"
}
}
},
"Contents": {
"description": "Wrapper for line items.",
"type": "object",
"properties": {
"lineItems": {
"description": "List of order line items.\nAt least 1 line_item is required and at-most 50 is allowed.\nAll line items must belong to same vertical.",
"type": "array",
"items": {
"$ref": "#/definitions/LineItem"
}
}
}
},
"LineItem": {
"description": "One line item contains one vertical. An order or cart can have multiple\nline items of same vertical. Sub-line items/add-ons etc should be defined in\nvertical protos depending on their use cases.\nNote:\n1. All strings at all levels must be less than 1000 chars unless otherwise\nspecified.\n2. All repeated fields at all levels must be less than 50 in count unless\notherwise specified.\n3. All timestamps at all levels, if specified, must be valid timestamps.",
"type": "object",
"properties": {
"id": {
"description": "Required: Merchant assigned identifier for line item.\nUsed for identifying existing line item in applying partial updates.\nMax allowed length is 64 chars.",
"type": "string"
},
"name": {
"description": "Name of line item as displayed on the receipt.\nMax allowed length is 100 chars.",
"type": "string"
},
"userVisibleStateLabel": {
"description": "Deprecated. Use vertical level status instead. For example, for purchases,\nuse PurchaseOrderExtension.status.\nUser visible label for the state of this line item.",
"type": "string"
},
"provider": {
"description": "The provider of the particular line item, if different from the overall\norder. Example: Expedia Order with line item provider ANA.",
"$ref": "#/definitions/Merchant"
},
"priceAttributes": {
"description": "Line item level price and adjustments.",
"type": "array",
"items": {
"$ref": "#/definitions/PriceAttribute"
}
},
"followUpActions": {
"description": "Follow up actions at line item.",
"type": "array",
"items": {
"$ref": "#/definitions/Action"
}
},
"recipients": {
"description": "Line item level customers, this could be different from Order level buyer.\nExample: User X made restaurant reservation under name of user Y.",
"type": "array",
"items": {
"$ref": "#/definitions/UserInfo"
}
},
"image": {
"description": "Small image associated with this item, if any.",
"$ref": "#/definitions/V2UiElementsImage"
},
"description": {
"description": "Line item description.",
"type": "string"
},
"notes": {
"description": "Additional notes applicable to this particular line item, for example\ncancellation policy.",
"type": "array",
"items": {
"type": "string"
}
},
"disclosures": {
"description": "Disclosures associated with this line item.",
"type": "array",
"items": {
"$ref": "#/definitions/Disclosure"
}
},
"purchase": {
"description": "Purchase orders like goods, food etc.",
"$ref": "#/definitions/PurchasePurchaseItemExtension"
},
"reservation": {
"description": "Reservation orders like restaurant, haircut etc.",
"$ref": "#/definitions/ReservationReservationItemExtension"
},
"vertical": {
"description": "Deprecated: Use verticals instead.\nRequired: Semantic Contents of line item based on its type/vertical.\nEvery vertical should include its own fulfillment details.\nMust be either one of the following values:\ngoogle.actions.orders.v3.verticals.purchase.PurchaseItemExtension\ngoogle.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension",
"type": "object"
}
}
},
"PriceAttribute": {
"description": "Price attribute of an order or a line item.",
"type": "object",
"properties": {
"type": {
"description": "Required: Type of money attribute.",
"type": "string",
"enum": [
"TYPE_UNSPECIFIED",
"REGULAR",
"DISCOUNT",
"TAX",
"DELIVERY",
"SUBTOTAL",
"FEE",
"GRATUITY",
"TOTAL"
]
},
"name": {
"description": "Required: User displayed string of the price attribute. This is sent and\nlocalized by merchant.",
"type": "string"
},
"id": {
"description": "Optional: Id of the lineitem to which this price corresponds.",
"type": "string"
},
"state": {
"description": "Required: State of the price: Estimate vs Actual.",
"type": "string",
"enum": [
"STATE_UNSPECIFIED",
"ESTIMATE",
"ACTUAL"
]
},
"amount": {
"description": "Monetary amount.",
"$ref": "#/definitions/Money"
},
"amountMillipercentage": {
"description": "The percentage spec, to 1/1000th of a percent.\nEg: 8.750% is represented as 8750, negative percentages represent\npercentage discounts.\nDeprecating this field. Can consider adding back when a solid usecase is\nrequired.",
"type": "integer",
"format": "int32"
},
"taxIncluded": {
"description": "Whether the price is tax included.",
"type": "boolean"
}
}
},
"Money": {
"description": "Represents an amount of money with its currency type.",
"type": "object",
"properties": {
"currencyCode": {
"description": "The 3-letter currency code defined in ISO 4217.",
"type": "string"
},
"amountInMicros": {
"description": "Amount in micros.\nFor example, this field should be set as 1990000 for $1.99.",
"type": "string",
"format": "int64"
}
}
},
"Action": {
"description": "A follow-up action associated with the order or line item.",
"type": "object",
"properties": {
"type": {
"description": "Required: Type of action.",
"type": "string",
"enum": [
"TYPE_UNSPECIFIED",
"VIEW_DETAILS",
"MODIFY",
"CANCEL",
"RETURN",
"EXCHANGE",
"EMAIL",
"CALL",
"REORDER",
"REVIEW",
"CUSTOMER_SERVICE",
"FIX_ISSUE",
"DIRECTION"
]
},
"title": {
"description": "Title or label of the action, displayed to the user.\nMax allowed length is 100 chars.",
"type": "string"
},
"openUrlAction": {
"description": "Action to take.",
"$ref": "#/definitions/V2UiElementsOpenUrlAction"
},
"actionMetadata": {
"description": "Metadata associated with an action.",
"$ref": "#/definitions/ActionMetadata"
}
}
},
"V2UiElementsOpenUrlAction": {
"description": "Opens the given url.",
"type": "object",
"properties": {
"url": {
"description": "The url field which could be any of:\n- http/https urls for opening an App-linked App or a webpage",
"type": "string"
},
"androidApp": {
"description": "Information about the Android App if the URL is expected to be\nfulfilled by an Android App.",
"$ref": "#/definitions/V2DevicesAndroidApp"
},
"urlTypeHint": {
"description": "Indicates a hint for the url type.",
"type": "string",
"enum": [
"URL_TYPE_HINT_UNSPECIFIED",
"AMP_CONTENT"
]
}
}
},
"V2DevicesAndroidApp": {
"description": "Specification of the Android App for fulfillment restrictions",
"type": "object",
"properties": {
"packageName": {
"description": "Package name\nPackage name must be specified when specifing Android Fulfillment.",
"type": "string"
},
"versions": {
"description": "When multiple filters are specified, any filter match will trigger the app.",
"type": "array",
"items": {
"$ref": "#/definitions/V2DevicesVersionFilter"
}
}
}
},
"V2DevicesVersionFilter": {
"description": "VersionFilter should be included if specific version/s of the App are\nrequired.",
"type": "object",
"properties": {
"minVersion": {
"description": "Min version code or 0, inclusive.",
"type": "integer",
"format": "int32"
},
"maxVersion": {
"description": "Max version code, inclusive.\nThe range considered is [min_version:max_version].\nA null range implies any version.\nExamples:\nTo specify a single version use: [target_version:target_version].\nTo specify any version leave min_version and max_version unspecified.\nTo specify all versions until max_version, leave min_version unspecified.\nTo specify all versions from min_version, leave max_version unspecified.",
"type": "integer",
"format": "int32"
}
}
},
"ActionMetadata": {
"description": "Related Metadata per action.",
"type": "object",
"properties": {
"expireTime": {
"description": "Time when this action will expire.",
"type": "string",
"format": "google-datetime"
}
}
},
"Disclosure": {
"description": "A product, service or policy disclosure that may be presented to the user.",
"type": "object",
"properties": {
"title": {
"description": "Title of the disclosure. Example: \"Safety information\".",
"type": "string"
},
"disclosureText": {
"description": "Content of the disclosure. Weblinks are allowed.",
"$ref": "#/definitions/DisclosureText"
},
"presentationOptions": {
"description": "Presentation options for the disclosure.",
"$ref": "#/definitions/DisclosurePresentationOptions"
}
}
},
"DisclosureText": {
"description": "Represents a plain text with web links.",
"type": "object",
"properties": {
"template": {
"description": "Text to display, containing placeholders like \"{0}\" and \"{1}\" for each\ntextlink that should be inserted. Example:\n\"WARNING: This product can expose you to chemicals which are known to the\nState of California to cause cancer. For more information go to {0}.\"\nThis disclosure text must not contain any promotional or ad-like content.",
"type": "string"
},
"textLinks": {
"description": "Text links that should be substituted into the template. The first one\nwill be substituted for \"{0}\" in the template string, and the second one\nfor \"{1}\", etc.",
"type": "array",
"items": {
"$ref": "#/definitions/TextLink"
}
}
}
},
"TextLink": {
"description": "A text link that should be substituted into the template.",
"type": "object",
"properties": {
"displayText": {
"description": "Text that should be displayed to users.",
"type": "string"
},
"url": {
"description": "URL to which users should be directed when the link is activated.",
"type": "string"
}
}
},
"DisclosurePresentationOptions": {
"description": "Options for the presentation of a disclosure.",
"type": "object",
"properties": {
"presentationRequirement": {
"description": "Presentation requirement of the disclosure.",
"type": "string",
"enum": [
"REQUIREMENT_UNSPECIFIED",
"REQUIREMENT_OPTIONAL",
"REQUIREMENT_REQUIRED"
]
},
"initiallyExpanded": {
"description": "Whether the content of the disclosure should be initially expanded.\nBy default, it is initially collapsed.",
"type": "boolean"
}
}
},
"PurchasePurchaseItemExtension": {
"description": "Line item contents of Purchase Vertical.",
"type": "object",
"properties": {
"status": {
"description": "Required: Line item level status.",
"type": "string",
"enum": [
"PURCHASE_STATUS_UNSPECIFIED",
"READY_FOR_PICKUP",
"SHIPPED",
"DELIVERED",
"OUT_OF_STOCK",
"IN_PREPARATION",
"CREATED",
"CONFIRMED",
"REJECTED",
"RETURNED",
"CANCELLED",
"CHANGE_REQUESTED"
]
},
"userVisibleStatusLabel": {
"description": "Required: User visible label/string for the status.\nMax allowed length is 50 chars.",
"type": "string"
},
"type": {
"description": "Required: Type of purchase.",
"type": "string",
"enum": [
"PURCHASE_TYPE_UNSPECIFIED",
"RETAIL",
"FOOD",
"GROCERY",
"MOBILE_RECHARGE"
]
},
"productId": {
"description": "Product or offer id associated with this line item.",
"type": "string"
},
"quantity": {
"description": "Quantity of the item.",
"type": "integer",
"format": "int32"
},
"unitMeasure": {
"description": "Unit measure.\nSpecifies the size of the item in chosen units. The size, together with\nthe active price is used to determine the unit price.",
"$ref": "#/definitions/PurchaseMerchantUnitMeasure"
},
"returnsInfo": {
"description": "Returns info for this line item. If unset, this line item\ninherits order level returns info.",
"$ref": "#/definitions/PurchasePurchaseReturnsInfo"
},
"fulfillmentInfo": {
"description": "Fulfillment info for this line item. If unset, this line item\ninherits order level fulfillment info.",
"$ref": "#/definitions/PurchasePurchaseFulfillmentInfo"
},
"itemOptions": {
"description": "Additional add-ons or sub-items.",
"type": "array",
"items": {
"$ref": "#/definitions/PurchaseItemOption"
}
},
"productDetails": {
"description": "Details about the product.",
"$ref": "#/definitions/PurchaseProductDetails"
},
"extension": {
"description": "Any extra fields exchanged between merchant and google.\nNote: Use of this extension is highly discouraged. Based on the\nuse-case/circumstances, consider one of the following:\n1. Define fields in the PurchaseItemExtension if it could be used for other\nuse-cases (ie. generic capability/functionality).\n2. Use vertical_extension if it is specific to a custom, non-generic\nuse-case/feature.",
"type": "object"
}
}
},
"PurchaseMerchantUnitMeasure": {
"description": "Merchant unit pricing measure.",
"type": "object",
"properties": {
"measure": {
"description": "Value: Example 1.2.",
"type": "number",
"format": "double"
},
"unit": {
"description": "Unit: Example POUND, GRAM.",
"type": "string",
"enum": [
"UNIT_UNSPECIFIED",
"MILLIGRAM",
"GRAM",
"KILOGRAM",
"OUNCE",
"POUND"
]
}
}
},
"PurchasePurchaseReturnsInfo": {
"description": "Returns info associated with an order or a particular line item.",
"type": "object",
"properties": {
"isReturnable": {
"description": "If true, return is allowed.",
"type": "boolean"
},
"daysToReturn": {
"description": "Return is allowed within that many days.",
"type": "integer",
"format": "int32"
},
"policyUrl": {
"description": "Link to the return policy.",
"type": "string"
}
}
},
"PurchasePurchaseFulfillmentInfo": {
"description": "Fulfillment info associated with a purchase order or a particular line item.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for this service option.",
"type": "string"
},
"fulfillmentType": {
"description": "Required: The type of fulfillment.",
"type": "string",
"enum": [
"TYPE_UNSPECIFIED",
"DELIVERY",
"PICKUP"
]
},
"expectedFulfillmentTime": {
"description": "A window if a time-range is specified or ETA if single time specified.\nExpected delivery or pickup time.",
"$ref": "#/definitions/Time"
},
"expectedPreparationTime": {
"description": "A window if a time-range is specified or ETA if single time specified.\nExpected time to prepare the food. Single-time preferred.",
"$ref": "#/definitions/Time"
},
"location": {
"description": "Pickup or delivery location.",
"$ref": "#/definitions/V2Location"
},
"expireTime": {
"description": "Time at which this fulfillment option expires.",
"type": "string",
"format": "google-datetime"
},
"price": {
"description": "Cost of this option.",
"$ref": "#/definitions/PriceAttribute"
},
"fulfillmentContact": {
"description": "User contact for this fulfillment.",
"$ref": "#/definitions/UserInfo"
},
"shippingMethodName": {
"description": "Name of the shipping method selected by the user.",
"type": "string"
},
"storeCode": {
"description": "StoreCode of the location.\nExample: Walmart is the merchant and store_code is the walmart store\nwhere fulfillment happened.\nhttps://support.google.com/business/answer/3370250?ref_topic=4596653.",
"type": "string"
},
"pickupInfo": {
"description": "Additional information regarding how order would be picked. This field\nwould only be applicable when fulfillment type is PICKUP.",
"$ref": "#/definitions/PurchasePickupInfo"
}
}
},
"Time": {
"description": "Time construct to represent time of an event to use when displaying an order\nto the user.",
"type": "object",
"properties": {
"timeIso8601": {
"description": "Represents an order-event time like reservation time, delivery time and so\non. Could be a duration (start & end time), just the date, date time etc.\nRefer https://en.wikipedia.org/wiki/ISO_8601 for all supported formats.",
"type": "string"
}
}
},
"PurchasePickupInfo": {
"description": "Details about how an order is picked up. It includes details such as pickup\ntype and additional metadata attached with each type, if any.",
"type": "object",
"properties": {
"pickupType": {
"description": "Pick up method, such as INSTORE, CURBSIDE etc.",
"type": "string",
"enum": [
"UNSPECIFIED",
"INSTORE",
"CURBSIDE"
]
},
"curbsideInfo": {
"description": "Details specific to the curbside information. If pickup_type is not\n\"CURBSIDE\", this field would be ignored.",
"$ref": "#/definitions/PurchaseCurbsideInfo"
},
"checkInInfo": {
"description": "List of various methods supported by partner to support check-in.",
"type": "array",
"items": {
"$ref": "#/definitions/CommonCheckInInfo"
}
}
}
},
"PurchaseCurbsideInfo": {
"description": "Details about how curbside order would be facilitated.",
"type": "object",
"properties": {
"curbsideFulfillmentType": {
"description": "Partners need additional information to facilitate curbside pickup\norders. Depending upon what fulfillment type is chosen, corresponding\ndetails would be collected from the user.",
"type": "string",
"enum": [
"UNSPECIFIED",
"VEHICLE_DETAIL"
]
},
"userVehicle": {
"description": "Vehicle details of the user placing the order.",
"$ref": "#/definitions/CommonVehicle"
}
}
},
"CommonVehicle": {
"description": "Details about a vehicle",
"type": "object",
"properties": {
"make": {
"description": "Vehicle make (e.g. \"Honda\").\nThis is displayed to the user and must be localized.\nRequired.",
"type": "string"
},
"model": {
"description": "Vehicle model (e.g. \"Grom\").\nThis is displayed to the user and must be localized.\nRequired.",
"type": "string"
},
"licensePlate": {
"description": "Vehicle license plate number (e.g. \"1ABC234\").\nRequired.",
"type": "string"
},
"colorName": {
"description": "Vehicle color name, eg. black\nOptional.",
"type": "string"
},
"image": {
"description": "URL to a photo of the vehicle.\nThe photo will be displayed at approximately 256x256px.\nMust be a jpg or png.\nOptional.",
"$ref": "#/definitions/V2UiElementsImage"
}
}
},
"CommonCheckInInfo": {
"description": "Metadata required by partner to support a checkin method.",
"type": "object",
"properties": {
"checkInType": {
"description": "Method used to send checkin instructions.",
"type": "string",
"enum": [
"CHECK_IN_TYPE_UNSPECIFIED",
"EMAIL",
"SMS"
]
}
}
},
"PurchaseItemOption": {
"description": "Represents add-ons or sub-items.",
"type": "object",
"properties": {
"id": {
"description": "For options that are items, unique item id.",
"type": "string"
},
"name": {
"description": "Option name.",
"type": "string"
},
"prices": {
"description": "Option total price.",
"type": "array",
"items": {
"$ref": "#/definitions/PriceAttribute"
}
},
"note": {
"description": "Note related to the option.",
"type": "string"
},
"quantity": {
"description": "For options that are items, quantity.",
"type": "integer",
"format": "int32"
},
"productId": {
"description": "Product or offer id associated with this option.",
"type": "string"
},
"subOptions": {
"description": "To define other nested sub options.",
"type": "array",
"items": {
"$ref": "#/definitions/PurchaseItemOption"
}
}
}
},
"PurchaseProductDetails": {
"description": "Details about the product.",
"type": "object",
"properties": {
"productId": {
"description": "Product or offer id associated with this line item.",
"type": "string"
},
"gtin": {
"description": "Global Trade Item Number of the product.\nUseful if offerId is not present in Merchant Center. Optional.",
"type": "string"
},
"plu": {
"description": "Price look-up codes, commonly called PLU codes, PLU numbers, PLUs,\nproduce codes, or produce labels, are a system of numbers that\nuniquely identify bulk produce sold in grocery stores and supermarkets.",
"type": "string"
},
"productType": {
"description": "Product category defined by the merchant.\nE.g. \"Home > Grocery > Dairy & Eggs > Milk > Whole Milk\"",
"type": "string"
},
"productAttributes": {
"description": "Merchant-provided details about the product,\ne.g. { \"allergen\": \"peanut\" }.\nUseful if offerId is not present in Merchant Center. Optional.",
"type": "object"
}
}
},
"ReservationReservationItemExtension": {
"description": "Line item contents for reservation orders like restaurant, haircut etc.",
"type": "object",
"properties": {
"status": {
"description": "Required: Reservation status.",
"type": "string",
"enum": [
"RESERVATION_STATUS_UNSPECIFIED",
"PENDING",
"CONFIRMED",
"CANCELLED",
"FULFILLED",
"CHANGE_REQUESTED",
"REJECTED"
]
},
"userVisibleStatusLabel": {
"description": "Required: User visible label/string for the status.\nMax allowed length is 50 chars.",
"type": "string"
},
"type": {
"description": "Type of reservation.\nMay be unset if none of the type options is applicable.",
"type": "string",
"enum": [
"RESERVATION_TYPE_UNSPECIFIED",
"RESTAURANT",
"HAIRDRESSER"
]
},
"reservationTime": {
"description": "Time when the service/event is scheduled to occur.\nCan be a time range, a date, or an exact date time.",
"$ref": "#/definitions/Time"
},
"userAcceptableTimeRange": {
"description": "Time range that is acceptable to the user.",
"$ref": "#/definitions/Time"
},
"confirmationCode": {
"description": "Confirmation code for this reservation.",
"type": "string"
},
"partySize": {
"description": "The number of people.",
"type": "integer",
"format": "int32"
},
"staffFacilitators": {
"description": "Staff facilitators who will be servicing the reservation.\nEx. The hairstylist.",
"type": "array",
"items": {
"$ref": "#/definitions/ReservationStaffFacilitator"
}
},
"location": {
"description": "Location of the service/event.",
"$ref": "#/definitions/V2Location"
}
}
},
"ReservationStaffFacilitator": {
"description": "Information about service person.",
"type": "object",
"properties": {
"name": {
"description": "The staff facilitator's name. Ex. \"John Smith\"",
"type": "string"
},
"image": {
"description": "Performer's images.",
"$ref": "#/definitions/V2UiElementsImage"
}
}
},
"PaymentData": {
"description": "Payment data related to an order.",
"type": "object",
"properties": {
"paymentResult": {
"description": "Payment result that's used by integrator for completing a transaction.\nThis field will be populated by Actions on Google if the checkout\nexperience is managed by Actions-on-Google.",
"$ref": "#/definitions/PaymentResult"
},
"paymentInfo": {
"description": "Payment information regarding the order that's useful for user facing\ninteraction.",
"$ref": "#/definitions/PaymentInfo"
}
}
},
"PaymentResult": {
"description": "Payment result used by integrator for completing a transaction.",
"type": "object",
"properties": {
"googlePaymentData": {
"description": "Google provided payment method data.\nIf your payment processor is listed as Google supported payment processor\nhere: https://developers.google.com/pay/api/ Navigate to your payment\nprocessor through the link to find out more details.\nOtherwise, refer to following documentation for payload details.\nhttps://developers.google.com/pay/api/payment-data-cryptography",
"type": "string"
},
"merchantPaymentMethodId": {
"description": "Merchant/Action provided payment method chosen by user.",
"type": "string"
}
}
},
"PaymentInfo": {
"description": "Payment information regarding the order being made.\nThis proto captures information that's useful for user facing interaction.",
"type": "object",
"properties": {
"paymentMethodDisplayInfo": {
"description": "The display info of the payment method used for the transaction.",
"$ref": "#/definitions/PaymentMethodDisplayInfo"
},
"paymentMethodProvenance": {
"description": "Provenance of the payment method used for the transaction.\nUser may have registered the same payment method with both google and\nmerchant.",
"type": "string",
"enum": [
"PAYMENT_METHOD_PROVENANCE_UNSPECIFIED",
"PAYMENT_METHOD_PROVENANCE_GOOGLE",
"PAYMENT_METHOD_PROVENANCE_MERCHANT"
]
}
}
},
"PaymentMethodDisplayInfo": {
"description": "Payment result used by integrator for completing a transaction.",
"type": "object",
"properties": {
"paymentType": {
"description": "The type of the payment.",
"type": "string",
"enum": [
"PAYMENT_TYPE_UNSPECIFIED",
"PAYMENT_CARD",
"BANK",
"LOYALTY_PROGRAM",
"CASH",
"GIFT_CARD",
"WALLET"
]
},
"paymentMethodDisplayName": {
"description": "User visible name of the payment method. For example,\nVISA **** 1234\nChecking acct **** 5678",
"type": "string"
},
"paymentMethodVoiceName": {
"description": "Payment method name to be spoken out to the user for voice-only\nassistant devices. For example,\n\"visa ending in one two three four\", or\n\"checking account ending in five six seven eight\".\nNote: This is the voice-optimized string to be used instead of the\npayment_method_display_name for voice-only assistant devices. If this\nstring is not set, payment_method_display_name will instead be spoken out\nto the user.",
"type": "string"
}
}
},
"Promotion": {
"description": "Promotions/Offers that were added to the cart.",
"type": "object",
"properties": {
"coupon": {
"description": "Required: Coupon code applied to this offer.",
"type": "string"
}
}
},
"PurchasePurchaseOrderExtension": {
"description": "Order extension for purchase vertical. These properties are applicable to\nall line items inside order, unless overridden in a line item.",
"type": "object",
"properties": {
"status": {
"description": "Required: Overall Status for the order.",
"type": "string",
"enum": [
"PURCHASE_STATUS_UNSPECIFIED",
"READY_FOR_PICKUP",
"SHIPPED",
"DELIVERED",
"OUT_OF_STOCK",
"IN_PREPARATION",
"CREATED",
"CONFIRMED",
"REJECTED",
"RETURNED",
"CANCELLED",
"CHANGE_REQUESTED"
]
},
"userVisibleStatusLabel": {
"description": "User visible label/string for the status.\nMax allowed length is 50 chars.",
"type": "string"
},
"type": {
"description": "Required: Type of purchase.",
"type": "string",
"enum": [
"PURCHASE_TYPE_UNSPECIFIED",
"RETAIL",
"FOOD",
"GROCERY",
"MOBILE_RECHARGE"
]
},
"returnsInfo": {
"description": "Return info for the order.",
"$ref": "#/definitions/PurchasePurchaseReturnsInfo"
},
"fulfillmentInfo": {
"description": "Fulfillment info for the order.",
"$ref": "#/definitions/PurchasePurchaseFulfillmentInfo"
},
"purchaseLocationType": {
"description": "Location of the purchase (in-store / online)",
"type": "string",
"enum": [
"UNSPECIFIED_LOCATION",
"ONLINE_PURCHASE",
"INSTORE_PURCHASE"
]
},
"errors": {
"description": "Optional: Errors because of which this order was rejected.",
"type": "array",
"items": {
"$ref": "#/definitions/PurchasePurchaseError"
}
},
"extension": {
"description": "Any extra fields exchanged between merchant and google.\nNote: Use of this extension is highly discouraged. Based on the\nuse-case/circumstances, consider one of the following:\n1. Define fields in the PurchaseOrderExtension if it could be used for\nother use-cases (ie. generic capability/functionality).\n2. Use vertical_extension if it is specific to a custom, non-generic\nuse-case/feature.",
"type": "object"
}
}
},
"PurchasePurchaseError": {
"description": "Errors that a purchase order can be rejected for.",
"type": "object",
"properties": {
"type": {
"description": "Required: This represents the granular reason why an order gets rejected by\nthe merchant.",
"type": "string",
"enum": [
"ERROR_TYPE_UNSPECIFIED",
"NOT_FOUND",
"INVALID",
"AVAILABILITY_CHANGED",
"PRICE_CHANGED",
"INCORRECT_PRICE",
"REQUIREMENTS_NOT_MET",
"TOO_LATE",
"NO_CAPACITY",
"INELIGIBLE",
"OUT_OF_SERVICE_AREA",
"CLOSED",
"PROMO_NOT_APPLICABLE",
"PROMO_NOT_RECOGNIZED",
"PROMO_EXPIRED",
"PROMO_USER_INELIGIBLE",
"PROMO_ORDER_INELIGIBLE",
"UNAVAILABLE_SLOT",
"FAILED_PRECONDITION",
"PAYMENT_DECLINED",
"MERCHANT_UNREACHABLE",
"ACCOUNT_LINKING_FAILED"
]
},
"description": {
"description": "Additional error description.",
"type": "string"
},
"entityId": {
"description": "Entity Id that corresponds to the error. Example this can correspond to\nLineItemId / ItemOptionId.",
"type": "string"
},
"updatedPrice": {
"description": "Relevant in case of PRICE_CHANGED / INCORRECT_PRICE error type.",
"$ref": "#/definitions/PriceAttribute"
},
"availableQuantity": {
"description": "Available quantity now. Applicable in case of AVAILABILITY_CHANGED.",
"type": "integer",
"format": "int32"
}
}
},
"TicketTicketOrderExtension": {
"description": "Order contents for ticket orders like movie, sports etc.",
"type": "object",
"properties": {
"ticketEvent": {
"description": "The event applied to all line item tickets.",
"$ref": "#/definitions/TicketTicketEvent"
}
}
},
"TicketTicketEvent": {
"description": "Represents a single event.",
"type": "object",
"properties": {
"type": {
"description": "Required: Type of the ticket event, e.g. movie, concert.",
"type": "string",
"enum": [
"EVENT_TYPE_UNKNOWN",
"MOVIE",
"CONCERT",
"SPORTS"
]
},
"name": {
"description": "Required: Name of the event. For example, if the event is a movie, this\nshould be the movie name.",
"type": "string"
},
"description": {
"description": "Description of the event.",
"type": "string"
},
"url": {
"description": "Url to the event info.",
"type": "string"
},
"location": {
"description": "The location where the event is happening, or an organization is located.",
"$ref": "#/definitions/V2Location"
},
"eventCharacters": {
"description": "The characters related to this event. It can be directors or actors of a\nmovie event, or performers of a concert, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/TicketEventCharacter"
}
},
"startDate": {
"description": "Start time.",
"$ref": "#/definitions/Time"
},
"endDate": {
"description": "End time.",
"$ref": "#/definitions/Time"
},
"doorTime": {
"description": "Entry time, which might be different from the event start time. e.g. the\nevent starts at 9am, but entry time is 8:30am.",
"$ref": "#/definitions/Time"
}
}
},
"TicketEventCharacter": {
"description": "One event character, e.g. organizer, performer etc.",
"type": "object",
"properties": {
"type": {
"description": "Type of the event character, e.g. actor or director.",
"type": "string",
"enum": [
"TYPE_UNKNOWN",
"ACTOR",
"PERFORMER",
"DIRECTOR",
"ORGANIZER"
]
},
"name": {
"description": "Name of the character.",
"type": "string"
},
"image": {
"description": "Character's images.",
"$ref": "#/definitions/V2UiElementsImage"
}
}
},
"UserNotification": {
"description": "Optional user notification to display as part of the Order update.",
"type": "object",
"properties": {
"title": {
"description": "The title for the user notification.\nMax allowed length is 30 chars.",
"type": "string"
},
"text": {
"description": "The contents of the notification.\nMax allowed length is 100 chars.",
"type": "string"
}
}
},
"NextScene": {
"description": "Represents the scene to be executed next.",
"type": "object",
"properties": {
"name": {
"description": "Name of the scene to be executed next.",
"type": "string"
}
}
},
"Session": {
"description": "Contains information on the current conversation session",
"type": "object",
"properties": {
"id": {
"description": "Required. Globally unique ID of the current conversation session.\nThis field is read-only.",
"type": "string"
},
"params": {
"description": "Required. List of all parameters collected from forms and intents during\nthe session. Key is the parameter name.\nParameters defined here will be merged\nwith parameters already defined in the session.\nParameters with a null value will be removed from the session.",
"type": "object"
},
"typeOverrides": {
"description": "Optional. Types scoped to the session.\nSession type defines can supplement or replace existing types.\nType names must be unique.",
"type": "array",
"items": {
"$ref": "#/definitions/TypeOverride"
}
},
"languageCode": {
"description": "Language of the current conversation session. Follows IETF BCP-47 language\ncode http://www.rfc-editor.org/rfc/bcp/bcp47.txt.\nThis could be different from user locale if the action uses multi-language\nfeatures. For example, when handler_response.expected.language is set, it\nchanges the conversation language for all following turns, which will be\nreflected in this field.",
"type": "string"
}
}
},
"TypeOverride": {
"description": "Represents an override for a type.",
"type": "object",
"properties": {
"name": {
"description": "Required. Name of the type to supplement or override.",
"type": "string"
},
"mode": {
"description": "Required. How this type should be merged with other type values.",
"type": "string",
"enum": [
"TYPE_UNSPECIFIED",
"TYPE_REPLACE",
"TYPE_MERGE"
]
},
"synonym": {
"$ref": "#/definitions/SynonymType"
}
}
},
"SynonymType": {
"description": "Represents a type with synonyms.",
"type": "object",
"properties": {
"entries": {
"description": "Required. List of entries for the synonym type.",
"type": "array",
"items": {
"$ref": "#/definitions/Entry"
}
}
}
},
"Entry": {
"description": "Represents a entry for a synonym type.",
"type": "object",
"properties": {
"name": {
"description": "Required. Name of the entry (e.g. \"bicycle\"). The entry in this field\nmust be included in repeated synonyms field to be recogonized as a valid\ntype value.",
"type": "string"
},
"synonyms": {
"description": "Required. List of synonyms for the entry (e.g. \"bike\", \"cycle\").",
"type": "array",
"items": {
"type": "string"
}
},
"display": {
"description": "Optional. The item display's information.",
"$ref": "#/definitions/EntryDisplay"
}
}
},
"EntryDisplay": {
"type": "object",
"properties": {
"title": {
"description": "Required. Title of the item. When tapped, this text will be\nposted back to the conversation verbatim as if the user had typed it.\nEach title must be unique among the set of collection items.",
"type": "string"
},
"description": {
"description": "Optional. Body text of the card.",
"type": "string"
},
"image": {
"description": "Optional. The image to display.",
"$ref": "#/definitions/Image"
},
"footer": {
"description": "Optional. Footer text for the browsing collection item, displayed below\nthe description. Single line of text, truncated with an ellipsis.",
"type": "string"
},
"openUrl": {
"description": "URL of document associated with browsing carousel item.\nRequired for browsing carousel.",
"$ref": "#/definitions/OpenUrl"
}
}
},
"User": {
"description": "Represents the user making a request to the Action.",
"type": "object",
"properties": {
"locale": {
"description": "Primary locale setting of the user making the request. Follows IETF BCP-47\nlanguage code http://www.rfc-editor.org/rfc/bcp/bcp47.txt However, the\nscript subtag is not included.",
"type": "string"
},
"params": {
"description": "Optional. List of all parameters associated with the current user.",
"type": "object"
},
"accountLinkingStatus": {
"description": "Whether the user account is linked to the app.",
"type": "string",
"enum": [
"ACCOUNT_LINKING_STATUS_UNSPECIFIED",
"NOT_LINKED",
"LINKED"
]
},
"verificationStatus": {
"description": "Indicates the verification status of the user.",
"type": "string",
"enum": [
"USER_VERIFICATION_STATUS_UNSPECIFIED",
"GUEST",
"VERIFIED"
]
},
"lastSeenTime": {
"description": "The timestamp of the last interaction with this user.\nThis field will be omitted if the user has not interacted with the agent\nbefore.",
"type": "string",
"format": "google-datetime"
},
"engagement": {
"description": "The engagement of the current user including any subscriptions to intents.",
"$ref": "#/definitions/Engagement"
},
"packageEntitlements": {
"description": "User's entitlements related to the Android package associated with the\ncurrent action.",
"type": "array",
"items": {
"$ref": "#/definitions/PackageEntitlements"
}
}
}
},
"Engagement": {
"description": "Provides additional read-only information about what engagement mechanisms\nthe current user has registered for. For example, it can be useful to know\nwhat intents the user is already subscribed to in order to avoid asking them\nto subscribe to the same intent again. i.e. This information can be used to\nconditionally route to a scene to set up DailyUpdates or PushNotifications\nonly if the user has not subscribed already.",
"type": "object",
"properties": {
"pushNotificationIntents": {
"description": "Contains a list of intents which the user has enabled push notification\nfor.",
"type": "array",
"items": {
"$ref": "#/definitions/IntentSubscription"
}
},
"dailyUpdateIntents": {
"description": "Contains a list of intents which the user has enabled daily update\nfor.",
"type": "array",
"items": {
"$ref": "#/definitions/IntentSubscription"
}
}
}
},
"IntentSubscription": {
"description": "Describes an existing IntentSubscription.",
"type": "object",
"properties": {
"intent": {
"description": "Name of the intent which is subscribed to.",
"type": "string"
},
"contentTitle": {
"description": "A short description of the subscription. It is used as the notification's\nlabel and when Assistant is requesting permission from the user.",
"type": "string"
}
}
},
"PackageEntitlements": {
"description": "A List of user's entitlements related to a package name.",
"type": "object",
"properties": {
"packageName": {
"description": "The Android package name specified in the action package.",
"type": "string"
},
"entitlements": {
"description": "The user's entitlements for the given package.",
"type": "array",
"items": {
"$ref": "#/definitions/Entitlement"
}
}
}
},
"Entitlement": {
"description": "Defines a user's digital entitlement.",
"type": "object",
"properties": {
"sku": {
"description": "Product sku. Package name for paid app, suffix of Finsky docid for\nin-app purchase and in-app subscription.\nMatch getSku() in Play InApp Billing API.",
"type": "string"
},
"skuType": {
"description": "The type of SKU.",
"type": "string",
"enum": [
"SKU_TYPE_UNSPECIFIED",
"IN_APP",
"SUBSCRIPTION",
"APP"
]
},
"inAppDetails": {
"description": "Only present for in-app purchase and in-app subs.",
"$ref": "#/definitions/SignedData"
}
}
},
"SignedData": {
"type": "object",
"properties": {
"inAppPurchaseData": {
"description": "Contains all inapp purchase data in JSON format.\nSee details in table 6 of\nhttps://developer.android.com/google/play/billing/billing_reference.html.",
"type": "object"
},
"inAppDataSignature": {
"description": "Matches IN_APP_DATA_SIGNATURE from getPurchases() method in Play InApp\nBilling API.",
"type": "string"
}
}
},
"Home": {
"description": "Represents the HomeGraph structure that the user's target device belongs to.",
"type": "object",
"properties": {
"params": {
"description": "Optional. List of parameters associated with the HomeGraph structure the target\ndevice belongs to.",
"type": "object"
}
}
},
"Device": {
"description": "Represents the device the user is using to make a request to the Action.",
"type": "object",
"properties": {
"capabilities": {
"description": "Required. the capabilities of the device making a request to the Action.",
"type": "array",
"items": {
"type": "string",
"enum": [
"UNSPECIFIED",
"SPEECH",
"RICH_RESPONSE",
"LONG_FORM_AUDIO",
"INTERACTIVE_CANVAS",
"WEB_LINK"
]
}
}
}
},
"Context": {
"description": "Contains context information when user makes query. Such context includes but\nnot limited to info about active media session, state of canvas web app, etc.",
"type": "object",
"properties": {
"media": {
"description": "Contains context information about current active media session.",
"$ref": "#/definitions/MediaContext"
}
}
},
"MediaContext": {
"description": "Contains context information about current active media session.",
"type": "object",
"properties": {
"progress": {
"description": "Media progress of current active media file.",
"type": "string",
"format": "google-duration"
}
}
},
"HandlerResponse": {
"description": "Represents a response sent from a developer's fulfillment to Actions on\nGoogle.",
"type": "object",
"properties": {
"prompt": {
"description": "Optional. Represents the prompts to be sent to the user, these prompts\nwill be appended to previously added messages unless explicitly\noverwritten.",
"$ref": "#/definitions/Prompt"
},
"scene": {
"description": "Optional. Represents the current and next scene. If `Scene.next` is set\nthe runtime will immediately transition to the specified scene.",
"$ref": "#/definitions/Scene"
},
"session": {
"description": "Optional. Describes data for the current session, session\nparameters can be created, updated, or removed by the fulfillment.",
"$ref": "#/definitions/Session"
},
"user": {
"description": "Optional. Use to specify user parameters to send back.",
"$ref": "#/definitions/User"
},
"home": {
"description": "Optional. Used to specify parameters related to the HomeGraph structure\nthat the target device belongs to. See\nhttps://developers.google.com/actions/smarthome/concepts/homegraph.",
"$ref": "#/definitions/Home"
},
"device": {
"description": "Optional. Use to move between Assistant devices the user has access to.",
"$ref": "#/definitions/Device"
},
"expected": {
"description": "Optional. Describes the expectations for the next dialog turn.",
"$ref": "#/definitions/Expected"
}
}
},
"Expected": {
"description": "Describes the expectations for the next dialog turn.",
"type": "object",
"properties": {
"speech": {
"description": "List of phrases the Action expects from the user's utterance for speech\nbiasing. Up to 1000 phrases are allowed.\nNote: This field has the same meaning as ExpectedInput.speech_biasing_hints\n in the v2 API.",
"type": "array",
"items": {
"type": "string"
}
},
"languageCode": {
"description": "Expected language (in BCP-47 format) of user's next input.\nFor a list of supported languages, see\nhttps://developers.google.com/assistant/console/languages-locales",
"type": "string"
}
}
}
},
"type": "object",
"properties": {
"request": {
"$ref": "#/definitions/HandlerRequest"
},
"response": {
"$ref": "#/definitions/HandlerResponse"
}
}
} | o18637 |
{
"properties": {
"date_range": {
"properties": {
"end_date": {
"description": "The end date of the news articles",
"format": "date",
"type": "string"
},
"start_date": {
"description": "The start date of the news articles",
"format": "date",
"type": "string"
}
},
"required": [
"start_date",
"end_date"
],
"type": "object"
},
"keywords": {
"description": "Keywords related to the news",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"keywords"
],
"type": "object"
} | search_news_a15c8733 |
{
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Image upgrade input",
"type": "object",
"properties": {
"image_uuid": {
"type": "string"
}
},
"required": [
"image_uuid"
]
} | o71308 |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_FlowDistinguisherMethod": {
"description": "FlowDistinguisherMethod specifies the method of a flow distinguisher.",
"properties": {
"type": {
"description": "`type` is the type of flow distinguisher method The supported types are \"ByUser\" and \"ByNamespace\". Required.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_FlowSchemaCondition": {
"description": "FlowSchemaCondition describes conditions for a FlowSchema.",
"properties": {
"lastTransitionTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "`lastTransitionTime` is the last time the condition transitioned from one status to another."
},
"message": {
"description": "`message` is a human-readable message indicating details about last transition.",
"type": "string"
},
"reason": {
"description": "`reason` is a unique, one-word, CamelCase reason for the condition's last transition.",
"type": "string"
},
"status": {
"description": "`status` is the status of the condition. Can be True, False, Unknown. Required.",
"type": "string"
},
"type": {
"description": "`type` is the type of the condition. Required.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_FlowSchemaSpec": {
"description": "FlowSchemaSpec describes how the FlowSchema's specification looks like.",
"properties": {
"distinguisherMethod": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_FlowDistinguisherMethod",
"description": "`distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string."
},
"matchingPrecedence": {
"_format": "int32",
"description": "`matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default.",
"type": "integer"
},
"priorityLevelConfiguration": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_PriorityLevelConfigurationReference",
"description": "`priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required."
},
"rules": {
"description": "`rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_PolicyRulesWithSubjects"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"priorityLevelConfiguration"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_FlowSchemaStatus": {
"description": "FlowSchemaStatus represents the current state of a FlowSchema.",
"properties": {
"conditions": {
"description": "`conditions` is a list of the current states of FlowSchema.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_FlowSchemaCondition"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"type"
],
"x-kubernetes-list-type": "map"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_GroupSubject": {
"description": "GroupSubject holds detailed information for group-kind subject.",
"properties": {
"name": {
"description": "name is the user group that matches, or \"*\" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_NonResourcePolicyRule": {
"description": "NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.",
"properties": {
"nonResourceURLs": {
"description": "`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example:\n - \"/healthz\" is legal\n - \"/hea*\" is illegal\n - \"/hea\" is legal but matches nothing\n - \"/hea/*\" also matches nothing\n - \"/healthz/*\" matches all per-component health checks.\n\"*\" matches all non-resource urls. if it is present, it must be the only entry. Required.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "set"
},
"verbs": {
"description": "`verbs` is a list of matching verbs and may not be empty. \"*\" matches all verbs. If it is present, it must be the only entry. Required.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "set"
}
},
"required": [
"verbs",
"nonResourceURLs"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_PolicyRulesWithSubjects": {
"description": "PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request.",
"properties": {
"nonResourceRules": {
"description": "`nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_NonResourcePolicyRule"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"resourceRules": {
"description": "`resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_ResourcePolicyRule"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"subjects": {
"description": "subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_Subject"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"subjects"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_PriorityLevelConfigurationReference": {
"description": "PriorityLevelConfigurationReference contains information that points to the \"request-priority\" being used.",
"properties": {
"name": {
"description": "`name` is the name of the priority level configuration being referenced Required.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_ResourcePolicyRule": {
"description": "ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request.",
"properties": {
"apiGroups": {
"description": "`apiGroups` is a list of matching API groups and may not be empty. \"*\" matches all API groups and, if present, must be the only entry. Required.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "set"
},
"clusterScope": {
"description": "`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.",
"type": "boolean"
},
"namespaces": {
"description": "`namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains \"*\". Note that \"*\" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "set"
},
"resources": {
"description": "`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ \"services\", \"nodes/status\" ]. This list may not be empty. \"*\" matches all resources and, if present, must be the only entry. Required.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "set"
},
"verbs": {
"description": "`verbs` is a list of matching verbs and may not be empty. \"*\" matches all verbs and, if present, must be the only entry. Required.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "set"
}
},
"required": [
"verbs",
"apiGroups",
"resources"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_ServiceAccountSubject": {
"description": "ServiceAccountSubject holds detailed information for service-account-kind subject.",
"properties": {
"name": {
"description": "`name` is the name of matching ServiceAccount objects, or \"*\" to match regardless of name. Required.",
"type": "string"
},
"namespace": {
"description": "`namespace` is the namespace of matching ServiceAccount objects. Required.",
"type": "string"
}
},
"required": [
"namespace",
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_Subject": {
"description": "Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.",
"properties": {
"group": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_GroupSubject"
},
"kind": {
"description": "Required",
"type": "string"
},
"serviceAccount": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_ServiceAccountSubject"
},
"user": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_UserSubject"
}
},
"required": [
"kind"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "kind",
"fields-to-discriminateBy": {
"group": "Group",
"serviceAccount": "ServiceAccount",
"user": "User"
}
}
]
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_UserSubject": {
"description": "UserSubject holds detailed information for user-kind subject.",
"properties": {
"name": {
"description": "`name` is the username that matches, or \"*\" to match all usernames. Required.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1",
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type."
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"time": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": "object"
},
"clusterName": {
"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
"type": "string"
},
"creationTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"deletionGracePeriodSeconds": {
"_format": "int64",
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"_format": "int64",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
}
},
"description": "FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a \"flow distinguisher\".",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": [
"string",
"null"
]
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"FlowSchema"
],
"type": [
"string",
"null"
]
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "`metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_FlowSchemaSpec",
"description": "`spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status"
},
"status": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_flowcontrol_v1alpha1_FlowSchemaStatus",
"description": "`status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status"
}
},
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "flowcontrol.apiserver.k8s.io",
"kind": "FlowSchema",
"version": "v1alpha1"
}
]
} | kb_363_Normalized |
{
"additionalProperties": false,
"definitions": {
"doi": {
"description": "Digital object identifier.",
"pattern": "10\\..+/.+",
"type": "string"
},
"language": {
"description": "Allowed values are taken from IETF BCP 47, ISO 639-1 language codes.",
"type": "string"
},
"nameIdentifiers": {
"items": {
"additionalProperties": false,
"properties": {
"nameIdentifier": {
"type": "string"
},
"nameIdentifierScheme": {
"type": "string"
},
"schemeURI": {
"$ref": "#/definitions/uri"
}
},
"required": [
"nameIdentifier",
"nameIdentifierScheme"
],
"type": "object"
},
"type": "array"
},
"uri": {
"description": "For adding future URI validation.",
"type": "string"
},
"year": {
"type": "string"
}
},
"description": "JSON representation of the DataCite v4.0 schema.",
"properties": {
"alternateIdentifiers": {
"description": "An identifier or identifiers other than the primary Identifier applied to the resource being registered. This may be any alphanumeric string which is unique within its domain of issue. May be used for local identifiers. AlternateIdentifier should be used for another identifier of the same instance (same location, same file).",
"items": {
"additionalProperties": false,
"properties": {
"alternateIdentifier": {
"type": "string"
},
"alternateIdentifierType": {
"type": "string"
}
},
"required": [
"alternateIdentifier",
"alternateIdentifierType"
],
"type": "object"
},
"type": "array"
},
"contributors": {
"description": "The institution or person responsible for collecting, creating, or otherwise contributing to the developement of the dataset. The personal name format should be: Family, Given.",
"items": {
"additionalProperties": false,
"properties": {
"affiliations": {
"items": {
"type": "string"
},
"type": "array"
},
"contributorName": {
"type": "string"
},
"contributorType": {
"enum": [
"ContactPerson",
"DataCollector",
"DataCurator",
"DataManager",
"Distributor",
"Editor",
"HostingInstitution",
"Other",
"Producer",
"ProjectLeader",
"ProjectManager",
"ProjectMember",
"RegistrationAgency",
"RegistrationAuthority",
"RelatedPerson",
"ResearchGroup",
"RightsHolder",
"Researcher",
"Sponsor",
"Supervisor",
"WorkPackageLeader"
]
},
"familyName": {
"type": "string"
},
"givenName": {
"type": "string"
},
"nameIdentifiers": {
"$ref": "#/definitions/nameIdentifiers"
}
},
"required": [
"contributorName",
"contributorType"
],
"type": "object"
},
"type": "array"
},
"creators": {
"additionalProperties": false,
"description": "The main researchers involved working on the data, or the authors of the publication in priority order. May be a corporate/institutional or personal name. Format: Family, Given",
"items": {
"affiliations": {
"items": {
"type": "string"
},
"type": "array"
},
"creatorName": {
"type": "string"
},
"familyName": {
"type": "string"
},
"givenName": {
"type": "string"
},
"nameIdentifiers": {
"$ref": "#/definitions/nameIdentifiers"
}
},
"required": [
"creatorName"
],
"type": "array"
},
"dates": {
"description": "Different dates relevant to the work.",
"items": {
"additionalProperties": false,
"properties": {
"date": {
"description": "YYYY,YYYY-MM-DD, YYYY-MM-DDThh:mm:ssTZD or any other format or level of granularity described in W3CDTF. Use RKMS-ISO8601 standard for depicting date ranges.",
"type": "string"
},
"dateType": {
"enum": [
"Accepted",
"Available",
"Collected",
"Copyrighted",
"Created",
"Issued",
"Submitted",
"Updated",
"Valid"
]
}
},
"required": [
"dateType"
],
"type": "object"
},
"type": "array"
},
"descriptions": {
"description": "All additional information that does not fit in any of the other categories. May be used for technical information. It is a best practice to supply a description.",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"minLength": 1,
"type": "string"
},
"descriptionType": {
"description": "The type of the description.",
"enum": [
"Abstract",
"Methods",
"SeriesInformation",
"TableOfContents",
"TechnicalInfo",
"Other"
],
"type": "string"
},
"lang": {
"$ref": "#/definitions/language"
}
},
"required": [
"description",
"descriptionType"
],
"type": "object"
},
"type": "array"
},
"formats": {
"description": "Technical format of the resource. Use file extension or MIME type where possible.",
"items": {
"type": "string"
},
"type": "array"
},
"fundingReferences": {
"description": "Information about financial support (funding) for the resource being registered.",
"items": {
"additionalProperties": false,
"properties": {
"awardNumber": {
"additionalProperties": false,
"description": "The code assigned by the funder to a sponsored award (grant).",
"properties": {
"awardNumber": {
"type": "string"
},
"awardURI": {
"$ref": "#/definitions/uri"
}
},
"required": [
"awardNumber"
],
"type": "object"
},
"awardTitle": {
"description": "The human readable title of the award (grant).",
"type": "string"
},
"funderIdentifier": {
"additionalProperties": false,
"description": "Uniquely identifies a funding entity, according to various types.",
"properties": {
"funderIdentifier": {
"type": "string"
},
"funderIdentifierType": {
"enum": [
"ISNI",
"GRID",
"Crossref Funder ID",
"Other"
],
"type": "string"
}
},
"required": [
"funderIdentifier",
"funderIdentifierType"
],
"type": "object"
},
"funderName": {
"description": "Name of the funding provider.",
"type": "string"
}
},
"required": [
"funderName"
],
"type": "object"
},
"type": "array"
},
"geoLocations": {
"description": "Spatial region or named place where the data was gathered or about which the data is focused.",
"items": {
"properties": {
"geoLocationBox": {
"additionalProperties": false,
"description": "The spatial limits of a box.",
"properties": {
"eastBoundLongitude": {
"description": "Eastern longitudinal dimension of box.",
"type": "number"
},
"northBoundLatitude": {
"description": "Northern latitudinal dimension of box.",
"type": "number"
},
"southBoundLatitude": {
"description": "Southern latitudinal dimension of box.",
"type": "number"
},
"westBoundLongitude": {
"description": "Western longitudinal dimension of box.",
"type": "number"
}
},
"required": [
"westBoundLongitude",
"eastBoundLongitude",
"southBoundLatitude",
"northBoundLatitude"
],
"type": "object"
},
"geoLocationPlace": {
"description": "Spatial region or named place where the data was gathered or about which the data is focused.",
"type": "string"
},
"geoLocationPoint": {
"additionalProperties": false,
"description": "A point location in space.",
"properties": {
"pointLatitude": {
"description": "Latitudinal dimension of point.",
"type": "number"
},
"pointLongitude": {
"description": "Longitudinal dimension of point.",
"type": "number"
}
},
"required": [
"pointLongitude",
"pointLatitude"
],
"type": "object"
},
"geoLocationPolygon": {
"additionalProperties": false,
"description": "A drawn polygon area, defined by a set of points and lines connecting the points in a closed chain.",
"properties": {
"polygonPoints": {
"description": "A point location in a polygon.",
"items": {
"additionalProperties": false,
"properties": {
"pointLatitude": {
"description": "Latitudinal dimension of point.",
"type": "number"
},
"pointLongitude": {
"description": "Longitudinal dimension of point.",
"type": "number"
}
},
"required": [
"pointLongitude",
"pointLatitude"
],
"type": "object"
},
"minItems": 3,
"type": "array"
}
},
"required": [
"polygonPoints"
],
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"identifier": {
"additionalProperties": false,
"description": "A persistent identifier that identifies a resource. Currently, only DOI is allowed.",
"properties": {
"identifier": {
"$ref": "#/definitions/doi"
},
"identifierType": {
"enum": [
"DOI"
]
}
},
"required": [
"identifier",
"identifierType"
],
"type": "object"
},
"language": {
"$ref": "#/definitions/language",
"description": "Primary language of the resource."
},
"publicationYear": {
"$ref": "#/definitions/year",
"description": "Year when the data is made publicly available. If an embargo period has been in effect, use the date when the embargo period ends. In the case of datasets, \"publish\" is understood to mean making the data available on a specific date to the community of researchers. If there is no standard publication year value, use the date that would be preferred from a citation perspective."
},
"publisher": {
"description": "The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role. In the case of datasets, \"publish\" is understood to mean making the data available to the community of researchers.",
"minLength": 1,
"type": "string"
},
"relatedIdentifiers": {
"description": "Identifiers of related resources. Use this property to indicate subsets of properties, as appropriate.",
"items": {
"additionalProperties": false,
"properties": {
"relatedIdentifier": {
"type": "string"
},
"relatedIdentifierType": {
"enum": [
"ARK",
"arXiv",
"bibcode",
"DOI",
"EAN13",
"EISSN",
"Handle",
"IGSN",
"ISBN",
"ISSN",
"ISTC",
"LISSN",
"LSID",
"PMID",
"PURL",
"UPC",
"URL",
"URN"
]
},
"relatedMetadataScheme": {
"type": "string"
},
"relationType": {
"enum": [
"IsCitedBy",
"Cites",
"IsSupplementTo",
"IsSupplementedBy",
"IsContinuedBy",
"Continues",
"IsNewVersionOf",
"IsPreviousVersionOf",
"IsPartOf",
"HasPart",
"IsReferencedBy",
"References",
"IsDocumentedBy",
"Documents",
"IsCompiledBy",
"Compiles",
"IsVariantFormOf",
"IsOriginalFormOf",
"IsIdenticalTo",
"HasMetadata",
"IsMetadataFor",
"Reviews",
"IsReviewedBy",
"IsDerivedFrom",
"IsSourceOf"
]
},
"schemeURI": {
"$ref": "#/definitions/uri"
}
},
"required": [
"relatedIdentifier",
"relationType",
"relatedIdentifierType"
],
"type": "object"
},
"type": "array"
},
"resourceType": {
"additionalProperties": false,
"description": "The type of a resource. You may enter an additional free text description. The format is open, but the preferred format is a single term of some detail so that a pair can be formed with the sub-property.",
"properties": {
"resourceType": {
"type": "string"
},
"resourceTypeGeneral": {
"description": "The general type of a resource.",
"enum": [
"Audiovisual",
"Collection",
"Dataset",
"Event",
"Image",
"InteractiveResource",
"Model",
"PhysicalObject",
"Service",
"Software",
"Sound",
"Text",
"Workflow",
"Other"
]
}
},
"required": [
"resourceTypeGeneral"
],
"type": "object"
},
"rightsList": {
"description": "Any rights information for this resource. Provide a rights management statement for the resource or reference a service providing such information. Include embargo information if applicable. Use the complete title of a license and include version information if applicable.",
"items": {
"additionalProperties": false,
"minProperties": 1,
"properties": {
"rights": {
"type": "string"
},
"rightsURI": {
"$ref": "#/definitions/uri"
}
},
"type": "object"
},
"type": "array"
},
"sizes": {
"description": "Unstructures size information about the resource.",
"items": {
"type": "string"
},
"type": "array"
},
"subjects": {
"items": {
"additionalProperties": false,
"description": "Subject, keywords, classification codes, or key phrases describing the resource.",
"minProperties": 1,
"properties": {
"lang": {
"$ref": "#/definitions/language"
},
"schemeURI": {
"$ref": "#/definitions/uri"
},
"subject": {
"type": "string"
},
"subjectScheme": {
"type": "string"
},
"valueURI": {
"$ref": "#/definitions/uri"
}
},
"type": "object"
},
"type": "array"
},
"titles": {
"items": {
"additionalProperties": false,
"description": "A name or title by which a resource is known.",
"properties": {
"lang": {
"$ref": "#/definitions/language"
},
"title": {
"minLength": 1,
"type": "string"
},
"titleType": {
"enum": [
"AlternativeTitle",
"Subtitle",
"TranslatedTitle",
"Other"
]
},
"type": {
"description": "WARNING: This field has been superseded by 'titleType'",
"enum": [
"AlternativeTitle",
"Subtitle",
"TranslatedTitle",
"Other"
]
}
},
"required": [
"title"
],
"type": "object"
},
"type": "array"
},
"version": {
"description": "Version number of the resource. If the primary resource has changed the version number increases. Register a new identifier for a major version change. Individual stewards need to determine which are major vs. minor versions. May be used in conjunction with properties 11 and 12 (AlternateIdentifier and RelatedIdentifier) to indicate various information updates. May be used in conjunction with property 17 (Description) to indicate the nature and file/record range of version.",
"type": "string"
}
},
"required": [
"identifier",
"creators",
"titles",
"publisher",
"publicationYear",
"resourceType"
],
"title": "DataCite v4.0",
"type": "object"
} | o66331 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"details_metadata": {
"type": "object",
"description": "generic metadata dict in details list",
"properties": {
"author": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bug_reporting": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"code_repository": {
"oneOf": [
{
"$ref": "#/definitions/metadata_code_repository"
},
{
"type": "null"
}
]
},
"declared_license": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dependencies": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"devel_dependencies": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"engines": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
]
},
"files": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"git_head": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"homepage": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"keywords": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"metadata": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
]
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"platform": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"readme": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scripts": {
"oneOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
]
},
"version": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maintainers": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"contributors": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"_tests_implemented": {
"type": "boolean"
},
"ecosystem": {
"type": "string"
},
"_dependency_tree_lock": {
"oneOf": [
{
"$ref": "#/definitions/metadata_lockfile"
},
{
"type": "null"
}
]
},
"path": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"metadata_code_repository": {
"type": "object",
"description": "Code repository description",
"properties": {
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"additionalProperties": false
},
"metadata_locked_dependency": {
"type": "object",
"description": "Locked dependency description",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"specification": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resolved": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/metadata_locked_dependency"
}
}
},
"additionalProperties": false
},
"metadata_lockfile": {
"type": "object",
"description": "Dependency lock file description",
"properties": {
"runtime": {
"type": "string"
},
"version": {
"type": "string"
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/metadata_locked_dependency"
}
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
},
"type": "object",
"description": "Result of Mercator worker",
"properties": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the schema",
"pattern": "^[a-zA-Z0-9_]+$"
},
"version": {
"type": "string",
"description": "Version of the schema",
"pattern": "^[0-9]+-[0-9]+-[0-9]+$"
},
"url": {
"type": "string",
"description": "Full URL of the schema",
"format": "uri"
}
},
"required": [
"name",
"version"
],
"additionalProperties": false
},
"_release": {
"type": "string",
"description": "Unique release id in form of \"ecosystem:package:version\""
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/details_metadata"
}
},
"status": {
"type": "string",
"enum": [
"success",
"error"
]
},
"summary": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"status",
"summary"
],
"additionalProperties": false,
"title": "metadata-v3-1-1"
} | o60994 |
{
"properties": {
"latitude": {
"description": "The latitude of the current location",
"type": "number"
},
"longitude": {
"description": "The longitude of the current location",
"type": "number"
},
"radius": {
"description": "The radius in meters to search for places",
"type": "integer"
},
"types": {
"description": "The types of places to search for",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"latitude",
"longitude",
"radius"
],
"type": "object"
} | find_nearby_places_162556f6 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {}
},
"geometry": {
"type": "object",
"properties": {}
}
},
"required": [
"attributes",
"geometry"
]
} | o43007 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://github.com/tmarrs/presentations/blob/master/JSON-at-Work-Schema/examples/schema/ex-13-USCommonAddrSchema.json",
"definitions": {
"US_zipCode": {
"type": "string",
"pattern": "^[0-9]{5}(-[0-9]{4})?$"
}
},
"properties": {
"US_zipCode": {
"$ref": "#/definitions/US_zipCode"
}
},
"required": [
"US_zipCode"
]
} | o81567 |
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/mimmi20/ua-result/master/schema/platform.json",
"definitions": {
"os": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"marketingName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"version": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"bits": {
"type": "integer"
}
},
"required": [
"name",
"marketingName",
"version",
"manufacturer",
"bits"
]
}
},
"$ref": "#/definitions/os"
} | o60856 |
{
"properties": {
"dimensions": {
"properties": {
"base": {
"description": "The base length of the shape (e.g. for triangles)",
"type": "number"
},
"height": {
"description": "The height of the shape (e.g. for triangles)",
"type": "number"
},
"length": {
"description": "The length of the shape",
"type": "number"
},
"radius": {
"description": "The radius of the shape",
"type": "number"
},
"width": {
"description": "The width of the shape",
"type": "number"
}
},
"required": [
"length",
"width",
"radius"
],
"type": "object"
},
"shape": {
"description": "The type of shape (e.g. rectangle, triangle, circle)",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_668ac89b |
{
"properties": {
"aliasname": {
"type": "string"
},
"dynamicrouting": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"id": {
"type": "integer"
},
"ifaces": {
"readonly": true,
"type": "string"
},
"ifnum": {
"readonly": true,
"type": "string"
},
"ipv6dynamicrouting": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"linklocalipv6addr": {
"readonly": true,
"type": "string"
},
"lsbitmap": {
"readonly": true,
"type": "integer"
},
"lstagbitmap": {
"readonly": true,
"type": "integer"
},
"mtu": {
"type": "integer"
},
"partitionname": {
"readonly": true,
"type": "string"
},
"portbitmap": {
"readonly": true,
"type": "integer"
},
"rnat": {
"readonly": true,
"type": "boolean"
},
"sdxvlan": {
"enum": [
"YES",
"NO"
],
"readonly": true,
"type": "string"
},
"sharing": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"tagbitmap": {
"readonly": true,
"type": "integer"
},
"tagged": {
"readonly": true,
"type": "boolean"
},
"tagifaces": {
"readonly": true,
"type": "string"
},
"vlantd": {
"readonly": true,
"type": "integer"
},
"vxlan": {
"readonly": true,
"type": "integer"
}
},
"title": "vlan",
"type": "object"
} | o30701 |
{
"properties": {
"dimensions": {
"properties": {
"base": {
"description": "The base of the triangle",
"type": "number"
},
"height": {
"description": "The height of the triangle",
"type": "number"
},
"radius": {
"description": "The radius of the circle",
"type": "number"
},
"side_length": {
"description": "The side length of the square",
"type": "number"
}
},
"required": [
"radius",
"side_length"
],
"type": "object"
},
"shape": {
"description": "The type of shape (e.g. circle, square, triangle)",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_f19f0de1 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"columns": {
"type": "array",
"items": {
"title": "Data Table Column",
"description": "Schema for a single Data Table Column",
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
]
},
"constraint": {
"type": "string",
"enum": [
"unique",
"required",
"optional"
]
},
"defaultValue": {
"type": [
"string",
"number",
"boolean"
]
}
},
"required": [
"name",
"dataType",
"constraint"
],
"additionalProperties": false
},
"maxItems": 50
}
}
} | o9810 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"orderid": {
"type": "string"
},
"orderperson": {
"type": "string"
},
"shipto": {
"required": [
"name",
"address",
"city",
"country"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
}
}
}
},
"required": [
"orderid",
"orderperson",
"shipto"
],
"type": "object"
} | o41698 |
{
"properties": {
"date": {
"description": "The date and time of the meeting",
"format": "date-time",
"type": "string"
},
"duration": {
"description": "The duration of the meeting in minutes",
"type": "integer"
},
"participants": {
"description": "The participants of the meeting",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "The title of the meeting",
"type": "string"
}
},
"required": [
"title",
"participants",
"date",
"duration"
],
"type": "object"
} | schedule_meeting_6a4d8038 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://github.com/route4me/json-schemas/blob/master/geocoding.dtd",
"type": "object",
"title": "Geocoding",
"properties": {
"key": {
"type": "string",
"title": "Key",
"description": "A unique identifier for the geocoding"
},
"name": {
"type": "string",
"title": "Name",
"description": "Specific description of the geocoding result"
},
"bbox": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"title": "Latitude",
"description": "Latitude"
},
"lng": {
"type": "number",
"title": "Longitude"
}
}
},
"title": "Bbox",
"description": "Boundary box"
},
"lat": {
"type": "number",
"title": "Latitude",
"description": "Latitude"
},
"lng": {
"type": "number",
"minimum": -180,
"maximum": 180,
"title": "Longitude",
"description": "Longitude"
},
"confidence": {
"type": "string",
"title": "Confidence",
"description": "Confidence (\"high\", \"medium\", \"low\")"
},
"type": {
"type": "string",
"title": "Type",
"description": "Non-standardized. Is used for tooltip (\"Street\", \"City\" etc)"
},
"postalCode": {
"type": "string",
"title": "Postal Code",
"description": "If the result has a postal code, it's returned here"
},
"countryRegion": {
"type": "string",
"title": "Country Region",
"description": "If the region is known, it's returned here"
},
"curbside_coordinates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"title": "Latitude",
"description": "Latitude"
},
"lng": {
"type": "number",
"title": "Longitude",
"description": "Longitude"
}
}
},
"title": "Curbside Coordinates",
"description": "Curbside Coordinates"
}
},
"required": [
"bbox",
"lat",
"lng"
]
} | o71407 |
{
"properties": {
"date_range": {
"properties": {
"end_date": {
"description": "The end date of the news articles",
"format": "date",
"type": "string"
},
"start_date": {
"description": "The start date of the news articles",
"format": "date",
"type": "string"
}
},
"required": [
"start_date",
"end_date"
],
"type": "object"
},
"keywords": {
"description": "The keywords to search for in news articles",
"items": {
"type": "string"
},
"type": "array"
},
"language": {
"description": "The language of the news articles",
"type": "string"
}
},
"required": [
"keywords"
],
"type": "object"
} | search_news_26b2d11c |
{
"additionalProperties": true,
"description": "Schema for an Adjust install event",
"minProperties": 1,
"properties": {
"adgroup_name": {
"description": "Adgroup name, as taken from the tracker e.g Reindeers",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adjust_device_id": {
"description": "Adjust device ID (all platforms) e.g 18546f6171f67e29d1cb983322ad1329",
"maxLength": 32,
"type": [
"string",
"null"
]
},
"adjust_tracker": {
"description": "6-character Adjust tracker token e.g abc123",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adjust_tracker_name": {
"description": "Current tracker name e.g Network1%3A%3AChristmas%3A%3AReindeers%3A%3A320x70_en",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adwords_adgroup_id": {
"description": "Google AdWords adgroup ID e.g 123456",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adwords_campaign_id": {
"description": "Google AdWords campaign ID e.g 12345678",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adwords_campaign_name": {
"description": "Google AdWords campaign name e.g iOS+UAC+US+re-engagement",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adwords_campaign_type": {
"description": "Google AdWords campaign type e.g UAC; Search; Display; Video",
"maxLength": 24,
"type": [
"string",
"null"
]
},
"adwords_creative_id": {
"description": "Google AdWords creative ID e.g 174021879258",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adwords_keyword": {
"description": "Google AdWords search keyword e.g hotel",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adwords_matchtype": {
"description": "Google AdWords search keyword and match type e.g hotel_Broad",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adwords_network_subtype": {
"description": "Google AdWords network subtype e.g GoogleSearch; AdMob",
"maxLength": 24,
"type": [
"string",
"null"
]
},
"adwords_network_type": {
"description": "Google AdWords network type e.g Display; Search",
"maxLength": 24,
"type": [
"string",
"null"
]
},
"adwords_placement": {
"description": "Google AdWords ad placement e.g mobile_app - 1",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"adwords_search_term": {
"description": "Google organic search term e.g sisyphos",
"maxLength": 2000,
"type": [
"string",
"null"
]
},
"adwords_video_id": {
"description": "Google AdWords video ID e.g 98765456784",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"android_id": {
"description": "Android ID (Android only) e.g 3accef2d7286d0de",
"maxLength": 16,
"type": [
"string",
"null"
]
},
"api_level": {
"description": "API level (Android only) e.g 13",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"app_id": {
"description": "Store App ID or Google Play Store e.g 332193586; de.is24.android; C013FJP3WF",
"maxLength": 1024,
"type": "string"
},
"app_name": {
"description": "Name of the app e.g MyApp",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"app_name_dashboard": {
"description": "Name of the app in the Adjust Dashboard e.g MyApp+Android",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"app_version": {
"description": "App version number (Android); build-version-number for the bundle (iOS) e.g 5.13.1 (Android), 5131 (iOS)",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"apple_ad_conversion_type": {
"description": "Download status: first or subsequent app download e.g Download; Redownload",
"maxLength": 24,
"type": [
"string",
"null"
]
},
"apple_ad_keyword_matchtype": {
"description": "Apple Search keyword matchtype e.g Broad; Exact",
"maxLength": 24,
"type": [
"string",
"null"
]
},
"apple_idfa": {
"description": "ID for advertisers (iOS only) e.g 8C6CBCOD-5F43-4765-A6E6-84DFF3D24707",
"maxLength": 36,
"type": [
"string",
"null"
]
},
"apple_idfv": {
"description": "Uppercase iOS ID for vendors e.g CCB300A0-DE1B-4D48-BC7E-599E453B8DD4",
"maxLength": 36,
"type": [
"string",
"null"
]
},
"attribution_type": {
"description": "Attribution method e.g fingerprint, device_tag, reftag, google, facebook",
"maxLength": 24,
"type": [
"string",
"null"
]
},
"campaign_name": {
"description": "Campaign name, as taken from the tracker e.g Christmas",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"city": {
"description": "Device city e.g Berlin",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"click_attribution_window": {
"description": "Attribution window settings for device matching (hours) e.g 168",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"click_referer": {
"description": "Referrer header from click e.g http%3A%2F%2Fwww.example.com%2F%3Ffoo%3Dbar",
"maxLength": 65535,
"type": [
"string",
"null"
]
},
"click_time": {
"description": "Attributed click timestamp e.g 1403568849",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"connection_type": {
"description": "Internet connection type e.g cellular, Cable%2FDSL, Corporate",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"conversion_duration": {
"description": "Time between click and install or reattribution in seconds e.g 72",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"cost_amount": {
"description": "Cost of the user engagement (available for ad spend tracking only)* e.g 4.99 ($4.99)",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"cost_currency": {
"description": "ISO 4217 currency code of the cost data (available for ad spend tracking only)* e.g USD",
"maxLength": 3,
"type": [
"string",
"null"
]
},
"cost_type": {
"description": "Type of ad spend being tracked (available for ad spend tracking only)* e.g CPI",
"maxLength": 8,
"type": [
"string",
"null"
]
},
"country": {
"description": "Device two-character country code e.g us",
"maxLength": 2,
"type": [
"string",
"null"
]
},
"country_subdivision": {
"description": "Device subdivision of country, e.g., state e.g Calfornia",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"created_at_time": {
"description": "Activity timestamp e.g 1404214665",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"creative_name": {
"description": "Creative name, as taken from the tracker e.g 320x70_en",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"deeplink": {
"description": "Deeplink URL appended to click URL e.g myapp://product?id=650",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"device_name": {
"description": "Device model number e.g SM-G313HZ",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"device_timezone": {
"description": "Device time zone e.g UTC+0400",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"device_type": {
"description": "Device type e.g phone, tablet",
"maxLength": 20,
"type": [
"string",
"null"
]
},
"engagement_time": {
"description": "Engagement timestamp e.g 1403566587",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"environment": {
"description": "Current Adjust SDK environment setting e.g production, sandbox",
"maxLength": 24,
"type": [
"string",
"null"
]
},
"event_name": {
"description": "Type of user activity",
"enum": [
"install"
],
"type": [
"string",
"null"
]
},
"fb_account_id": {
"description": "Facebook ad account ID that created the ad e.g 123456789",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fb_ad_objective_name": {
"description": "Facebook advertising objective e.g Post engagement",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fb_adgroup_id": {
"description": "Facebook ad ID e.g 23842594106590661",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fb_adgroup_name": {
"description": "Facebook ad name e.g MyApp Summer Promo",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fb_campaign_group_id": {
"description": "Facebook campaign ID e.g 23842588848920296",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fb_campaign_group_name": {
"description": "Facebook campaign name e.g DPA-PPM_SKU_PPM",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fb_campaign_id": {
"description": "Facebook ad set ID e.g 23842594106430661",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fb_campaign_name": {
"description": "Facebook ad set name e.g MyApp Promos",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fb_platform_position": {
"description": "Facebook platform position e.g rewarded_video",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"fingerprint_attribution_window": {
"description": "Attribution window settings for device fingerprinting (hours) e.g 18",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"fire_os_ad_id": {
"description": "Fire OS advertising identifier e.g 63c5519b-7e66-7ee6-aa5d-3b290743811f",
"maxLength": 36,
"type": [
"string",
"null"
]
},
"google_click_id": {
"description": "Google click ID e.g undefined",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"gplay_ad_id": {
"description": "Google Play Store advertising ID e.g 38400000-8cf0-11bd-b23e-10b96e40000d",
"maxLength": 36,
"type": [
"string",
"null"
]
},
"gplay_referer": {
"description": "Google Play Store referrer (Android only) e.g APPIA142157299513371854693246846",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"impression_attribution_window": {
"description": "Attribution window settings for impression matching (hours) e.g 24",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"impression_time": {
"description": "Attributed impression timestamp e.g 1403568830",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"install_begin_time": {
"description": "App download began timestamp (Android and Google Play Store only) e.g 1502254761",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"install_complete_time": {
"description": "App download completion timestamp (reported before Adjust install; Android and Google Play Store only) e.g 1441514522",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"install_time": {
"description": "Install (i.e., first app open) timestamp e.g 1404214634",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"ip_address": {
"description": "Device IP address e.g 8.8.8.8",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"is_impression_based": {
"description": "1 if impression-based engagement, 0 if not e.g 1",
"maxLength": 1,
"type": [
"string",
"null"
]
},
"is_organic": {
"description": "1 if organic traffic, 0 if non-organic e.g 0",
"maxLength": 1,
"type": [
"string",
"null"
]
},
"isp": {
"description": "Device internet service provider e.g Verizon Internet",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"language_code": {
"description": "Device two-character language code e.g en",
"maxLength": 2,
"type": [
"string",
"null"
]
},
"mac_md5": {
"description": "Uppercase MAC MD5 hash e.g 098f6bcd4621d373cade4e832627b4f6",
"maxLength": 32,
"type": [
"string",
"null"
]
},
"mac_sha1": {
"description": "Uppercase MAC SHA-1 hash e.g 282f2e4d6324ed731ee1ca4179deb6603f2bc5bc",
"maxLength": 40,
"type": [
"string",
"null"
]
},
"network_name": {
"description": "Network name, as taken from the tracker e.g Network1",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"os_name": {
"description": "Device operating system e.g ios",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"os_version": {
"description": "Operating system version number e.g 7.1.3",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"partner_parameters": {
"description": "Custom partner parameters collected by the Adjust SDK and transmitted to third party providers via postbacks e.g client_id",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"postal_code": {
"description": "Device postal code of IP address e.g 12101",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"referral_time": {
"description": "User landed on app Play Store page timestamp (Android and Google Play Store only) e.g 1836167739",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"rejection_reason": {
"description": "Reason for a rejected attribution e.g anonymous_traffic, distribution_outlier, too_many_engagements, engagement_injection, incorrect_signature",
"maxLength": 50,
"type": [
"string",
"null"
]
},
"sdk_version": {
"description": "Adjust SDK version (per app) e.g ios4.1.4",
"maxLength": 500,
"type": [
"string",
"null"
]
},
"store": {
"description": "Target store of click e.g itunes; google, wstore, wphone",
"maxLength": 24,
"type": [
"string",
"null"
]
},
"tracking_enabled": {
"description": "1 if tracking is enabled, 0 if not e.g 1",
"maxLength": 1,
"type": [
"string",
"null"
]
},
"tracking_limited": {
"description": "1 if tracking is limited, 0 if not e.g 0",
"maxLength": 1,
"type": [
"string",
"null"
]
},
"tweet_id": {
"description": "Unique tweet ID e.g 852130056168247296",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"twitter_line_item_id": {
"description": "Twitter line item ID e.g 7zpix",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"windows_ad_id": {
"description": "Windows advertising identifier e.g 107e8ea14329d4a2194ebbb6dc0c0fd7",
"maxLength": 32,
"type": [
"string",
"null"
]
},
"windows_phone_udid": {
"description": "Windows Phone unique device ID e.g e81644f1-46b6-4994-2903-1d1f1440c130",
"maxLength": 36,
"type": [
"string",
"null"
]
},
"windows_store_hwid": {
"description": "Windows Store hardware ID e.g JKJbFwIArpGAGDmcBTAvlAUMKJkHAMoSCADlJQkDHWG",
"maxLength": 43,
"type": [
"string",
"null"
]
},
"windows_store_naid": {
"description": "Windows Store network adapter ID e.g 5978aed4-82e5-28cf-8364-dfc64cb1fb84",
"maxLength": 36,
"type": [
"string",
"null"
]
}
},
"required": [
"app_id"
],
"self": {
"format": "jsonschema",
"name": "install",
"vendor": "com.adjust",
"version": "1-0-0"
},
"type": "object"
} | sp_0_Normalized |
{
"additionalProperties": false,
"definitions": {
"comparison": {
"enum": [
"=",
"!=",
"==",
"!==",
"<=",
">=",
"<",
">",
"starts",
"ends",
"contains",
"regex"
],
"type": "string"
},
"oid_group": {
"oneOf": [
{
"pattern": "^(\\.\\d+)+\\.?$",
"type": "string"
},
{
"items": {
"pattern": "^(\\.\\d+)+\\.?$",
"type": "string"
},
"type": "array"
}
]
},
"regex_group": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"snmpget": {
"additionalProperties": false,
"properties": {
"mib": {
"type": "string"
},
"mib_dir": {
"type": "string"
},
"oid": {
"type": "string"
},
"op": {
"$ref": "#/definitions/comparison"
},
"options": {
"pattern": "^-",
"type": "string"
},
"value": {
"anyOf": [
{
"type": [
"boolean",
"string"
]
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"required": [
"oid",
"value"
],
"type": "object"
},
"string_group": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"properties": {
"bad_hrSystemUptime": {
"type": "boolean"
},
"bad_if": {
"items": {
"type": "string"
},
"type": "array"
},
"bad_ifXEntry": {
"items": {
"type": "string"
},
"type": "array"
},
"bad_if_regexp": {
"$ref": "#/definitions/regex_group"
},
"bad_snmpEngineTime": {
"type": "boolean"
},
"bad_uptime": {
"type": "boolean"
},
"discovery": {
"items": {
"additionalProperties": false,
"minProperties": 1,
"properties": {
"snmpget": {
"$ref": "#/definitions/snmpget"
},
"snmpget_except": {
"$ref": "#/definitions/snmpget"
},
"sysDescr": {
"$ref": "#/definitions/string_group"
},
"sysDescr_except": {
"$ref": "#/definitions/string_group"
},
"sysDescr_regex": {
"$ref": "#/definitions/regex_group"
},
"sysDescr_regex_except": {
"$ref": "#/definitions/regex_group"
},
"sysObjectID": {
"$ref": "#/definitions/oid_group"
},
"sysObjectID_except": {
"$ref": "#/definitions/oid_group"
},
"sysObjectID_regex": {
"$ref": "#/definitions/regex_group"
},
"sysObjectID_regex_except": {
"$ref": "#/definitions/regex_group"
}
},
"type": "object"
},
"type": "array"
},
"discovery_modules": {
"additionalProperties": false,
"properties": {
"applications": {
"type": "boolean"
},
"arp-table": {
"type": "boolean"
},
"bgp-peers": {
"type": "boolean"
},
"charge": {
"type": "boolean"
},
"cisco-cef": {
"type": "boolean"
},
"cisco-mac-accounting": {
"type": "boolean"
},
"cisco-otv": {
"type": "boolean"
},
"cisco-pw": {
"type": "boolean"
},
"cisco-sla": {
"type": "boolean"
},
"cisco-vrf-lite": {
"type": "boolean"
},
"discovery-protocols": {
"type": "boolean"
},
"diskio": {
"type": "boolean"
},
"entity-physical": {
"type": "boolean"
},
"fdb-table": {
"type": "boolean"
},
"hr-device": {
"type": "boolean"
},
"ip6-addresses": {
"type": "boolean"
},
"ipmi": {
"type": "boolean"
},
"ipv4-addresses": {
"type": "boolean"
},
"ipv6-address": {
"type": "boolean"
},
"ipv6-addresses": {
"type": "boolean"
},
"junose-atm-vp": {
"type": "boolean"
},
"libvirt-vminfo": {
"type": "boolean"
},
"loadbalancers": {
"type": "boolean"
},
"mef": {
"type": "boolean"
},
"mempools": {
"type": "boolean"
},
"ntp": {
"type": "boolean"
},
"ospf": {
"type": "boolean"
},
"ports": {
"type": "boolean"
},
"ports-stack": {
"type": "boolean"
},
"processors": {
"type": "boolean"
},
"sensors": {
"type": "boolean"
},
"services": {
"type": "boolean"
},
"storage": {
"type": "boolean"
},
"stp": {
"type": "boolean"
},
"toner": {
"type": "boolean"
},
"ucd-diskio": {
"type": "boolean"
},
"ucd-mib": {
"type": "boolean"
},
"vlans": {
"type": "boolean"
},
"vmware-vminfo": {
"type": "boolean"
},
"vrf": {
"type": "boolean"
},
"wireless": {
"type": "boolean"
}
},
"type": "object"
},
"empty_ifdescr": {
"type": "boolean"
},
"good_if": {
"items": {
"type": "string"
},
"type": "array"
},
"group": {
"type": "string"
},
"icon": {
"type": "string"
},
"icons": {
"items": {
"type": "string"
},
"type": "array"
},
"ifXmcbc": {
"type": "boolean"
},
"ifname": {
"type": "boolean"
},
"ignore_mount_string": {
"items": {
"type": "string"
},
"type": "array"
},
"mib_dir": {
"$ref": "#/definitions/string_group"
},
"nobulk": {
"type": "boolean"
},
"os": {
"type": "string"
},
"over": {
"items": {
"additionalProperties": false,
"properties": {
"graph": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"graph",
"text"
],
"type": "object"
},
"type": "array"
},
"poller_modules": {
"additionalProperties": false,
"properties": {
"applications": {
"type": "boolean"
},
"arp-table": {
"type": "boolean"
},
"aruba-controller": {
"type": "boolean"
},
"bgp-peers": {
"type": "boolean"
},
"cipsec-tunnels": {
"type": "boolean"
},
"cisco-ace-loadbalancer": {
"type": "boolean"
},
"cisco-ace-serverfarms": {
"type": "boolean"
},
"cisco-asa-firewall": {
"type": "boolean"
},
"cisco-cbqos": {
"type": "boolean"
},
"cisco-cef": {
"type": "boolean"
},
"cisco-ipsec-flow-monitor": {
"type": "boolean"
},
"cisco-mac-accounting": {
"type": "boolean"
},
"cisco-otv": {
"type": "boolean"
},
"cisco-remote-access-monitor": {
"type": "boolean"
},
"cisco-sla": {
"type": "boolean"
},
"cisco-voice": {
"type": "boolean"
},
"cisco-vpdn": {
"type": "boolean"
},
"cisco-vrf-lite": {
"type": "boolean"
},
"entity-physical": {
"type": "boolean"
},
"fdb-table": {
"type": "boolean"
},
"hr-mib": {
"type": "boolean"
},
"ipSystemStats": {
"type": "boolean"
},
"ipmi": {
"type": "boolean"
},
"junose-atm-vp": {
"type": "boolean"
},
"libvirt-vminfo": {
"type": "boolean"
},
"loadbalancers": {
"type": "boolean"
},
"mef": {
"type": "boolean"
},
"mempools": {
"type": "boolean"
},
"mib": {
"type": "boolean"
},
"netscaler-vsvr": {
"type": "boolean"
},
"netstats": {
"type": "boolean"
},
"ntp": {
"type": "boolean"
},
"ospf": {
"type": "boolean"
},
"ports": {
"type": "boolean"
},
"processors": {
"type": "boolean"
},
"services": {
"type": "boolean"
},
"storage": {
"type": "boolean"
},
"stp": {
"type": "boolean"
},
"tnms-nbi": {
"type": "boolean"
},
"toner": {
"type": "boolean"
},
"ucd-diskio": {
"type": "boolean"
},
"ucd-mib": {
"type": "boolean"
},
"vlans": {
"type": "boolean"
},
"vmware-vminfo": {
"type": "boolean"
},
"wifi": {
"type": "boolean"
},
"wireless": {
"type": "boolean"
}
},
"type": "object"
},
"processor_stacked": {
"type": "boolean"
},
"register_mibs": {
"type": "object"
},
"rfc1628_compat": {
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"os",
"text",
"type"
],
"type": "object"
} | o89629 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Reject step",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"kind": {
"enum": [
"reject"
]
},
"label": {
"type": "string"
},
"title": {
"type": "string"
},
"reason": {
"enum": [
"busy",
"rejected"
]
},
"iface": {
"type": "object"
}
},
"required": [
"name",
"kind",
"label",
"title"
]
} | o58490 |
{
"properties": {
"action": {
"type": "string"
},
"appflowaction": {
"type": "string"
},
"builtin": {
"enum": [
"MODIFIABLE",
"DELETABLE",
"IMMUTABLE",
"PARTITION_ALL"
],
"readonly": true,
"type": "object"
},
"comment": {
"type": "string"
},
"feature": {
"enum": [
"WL",
"WebLogging",
"SP",
"SurgeProtection",
"LB",
"LoadBalancing",
"CS",
"ContentSwitching",
"CR",
"CacheRedirection",
"SC",
"SureConnect",
"CMP",
"CMPcntl",
"CompressionControl",
"PQ",
"PriorityQueuing",
"HDOSP",
"HttpDoSProtection",
"SSLVPN",
"AAA",
"GSLB",
"GlobalServerLoadBalancing",
"SSL",
"SSLOffload",
"SSLOffloading",
"CF",
"ContentFiltering",
"IC",
"IntegratedCaching",
"OSPF",
"OSPFRouting",
"RIP",
"RIPRouting",
"BGP",
"BGPRouting",
"REWRITE",
"IPv6PT",
"IPv6protocoltranslation",
"AppFw",
"ApplicationFirewall",
"RESPONDER",
"HTMLInjection",
"push",
"NSPush",
"NetScalerPush",
"AppFlow",
"CloudBridge",
"ISIS",
"ISISRouting",
"CH",
"CallHome",
"AppQoE",
"ContentAccelerator",
"SYSTEM",
"RISE",
"FEO",
"LSN",
"LargeScaleNAT",
"RDPProxy",
"Rep",
"Reputation",
"URLFiltering",
"VideoOptimization",
"ForwardProxy",
"SSLInterception",
"AdaptiveTCP",
"CQA",
"CI",
"ContentInspection",
"Bot"
],
"readonly": true,
"type": "string"
},
"hits": {
"readonly": true,
"type": "integer"
},
"logaction": {
"type": "string"
},
"name": {
"type": "string"
},
"newname": {
"type": "string"
},
"rule": {
"type": "string"
},
"undefaction": {
"type": "string"
},
"undefhits": {
"readonly": true,
"type": "integer"
}
},
"title": "responderpolicy",
"type": "object"
} | o30856 |
{
"properties": {
"acl": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"alg": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"appflowexport": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"builtin": {
"enum": [
"MODIFIABLE",
"DELETABLE",
"IMMUTABLE",
"PARTITION_ALL"
],
"readonly": true,
"type": "object"
},
"contentinspectionlog": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"dateformat": {
"enum": [
"MMDDYYYY",
"DDMMYYYY",
"YYYYMMDD"
],
"type": "string"
},
"dns": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"feature": {
"enum": [
"WL",
"WebLogging",
"SP",
"SurgeProtection",
"LB",
"LoadBalancing",
"CS",
"ContentSwitching",
"CR",
"CacheRedirection",
"SC",
"SureConnect",
"CMP",
"CMPcntl",
"CompressionControl",
"PQ",
"PriorityQueuing",
"HDOSP",
"HttpDoSProtection",
"SSLVPN",
"AAA",
"GSLB",
"GlobalServerLoadBalancing",
"SSL",
"SSLOffload",
"SSLOffloading",
"CF",
"ContentFiltering",
"IC",
"IntegratedCaching",
"OSPF",
"OSPFRouting",
"RIP",
"RIPRouting",
"BGP",
"BGPRouting",
"REWRITE",
"IPv6PT",
"IPv6protocoltranslation",
"AppFw",
"ApplicationFirewall",
"RESPONDER",
"HTMLInjection",
"push",
"NSPush",
"NetScalerPush",
"AppFlow",
"CloudBridge",
"ISIS",
"ISISRouting",
"CH",
"CallHome",
"AppQoE",
"ContentAccelerator",
"SYSTEM",
"RISE",
"FEO",
"LSN",
"LargeScaleNAT",
"RDPProxy",
"Rep",
"Reputation",
"URLFiltering",
"VideoOptimization",
"ForwardProxy",
"SSLInterception",
"AdaptiveTCP",
"CQA",
"CI",
"ContentInspection",
"Bot"
],
"readonly": true,
"type": "string"
},
"logfacility": {
"enum": [
"LOCAL0",
"LOCAL1",
"LOCAL2",
"LOCAL3",
"LOCAL4",
"LOCAL5",
"LOCAL6",
"LOCAL7"
],
"type": "string"
},
"loglevel": {
"enum": [
"ALL",
"EMERGENCY",
"ALERT",
"CRITICAL",
"ERROR",
"WARNING",
"NOTICE",
"INFORMATIONAL",
"DEBUG",
"NONE"
],
"type": "object"
},
"lsn": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"serverip": {
"type": "string"
},
"serverport": {
"type": "integer"
},
"sslinterception": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"subscriberlog": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"tcp": {
"enum": [
"NONE",
"ALL"
],
"type": "string"
},
"timezone": {
"enum": [
"GMT_TIME",
"LOCAL_TIME"
],
"type": "string"
},
"urlfiltering": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"userdefinedauditlog": {
"enum": [
"YES",
"NO"
],
"type": "string"
}
},
"title": "auditsyslogparams",
"type": "object"
} | o30062 |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AWSElasticBlockStoreVolumeSource": {
"description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
},
"partition": {
"_format": "int32",
"description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).",
"type": "integer"
},
"readOnly": {
"description": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\". If omitted, the default is \"false\". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "boolean"
},
"volumeID": {
"description": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Affinity": {
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAntiAffinity",
"description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureDiskVolumeSource": {
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"properties": {
"cachingMode": {
"description": "Host Caching mode: None, Read Only, Read Write.",
"type": "string"
},
"diskName": {
"description": "The Name of the data disk in the blob storage",
"type": "string"
},
"diskURI": {
"description": "The URI the data disk in the blob storage",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"kind": {
"description": "Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureFileVolumeSource": {
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.",
"properties": {
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretName": {
"description": "the name of secret that contains Azure Storage Account Name and Key",
"type": "string"
},
"shareName": {
"description": "Share Name",
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CSIVolumeSource": {
"description": "Represents a source location of a volume to mount, managed by an external CSI driver",
"properties": {
"driver": {
"description": "Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.",
"type": "string"
},
"nodePublishSecretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed."
},
"readOnly": {
"description": "Specifies a read-only configuration for the volume. Defaults to false (read/write).",
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"description": "VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.",
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Capabilities": {
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CephFSVolumeSource": {
"description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"monitors": {
"description": "Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /",
"type": "string"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "boolean"
},
"secretFile": {
"description": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"
},
"user": {
"description": "Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CinderVolumeSource": {
"description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: points to a secret object containing parameters used to connect to OpenStack."
},
"volumeID": {
"description": "volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapEnvSource": {
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapKeySelector": {
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapProjection": {
"description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.",
"properties": {
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapVolumeSource": {
"description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext",
"description": "Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort": {
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"_format": "int32",
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"_format": "int32",
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerState": {
"description": "ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.",
"properties": {
"running": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateRunning",
"description": "Details about a running container"
},
"terminated": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateTerminated",
"description": "Details about a terminated container"
},
"waiting": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateWaiting",
"description": "Details about a waiting container"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateRunning": {
"description": "ContainerStateRunning is a running state of a container.",
"properties": {
"startedAt": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time at which the container was last (re-)started"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateTerminated": {
"description": "ContainerStateTerminated is a terminated state of a container.",
"properties": {
"containerID": {
"description": "Container's ID in the format 'docker://<container_id>'",
"type": "string"
},
"exitCode": {
"_format": "int32",
"description": "Exit status from the last termination of the container",
"type": "integer"
},
"finishedAt": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time at which the container last terminated"
},
"message": {
"description": "Message regarding the last termination of the container",
"type": "string"
},
"reason": {
"description": "(brief) reason from the last termination of the container",
"type": "string"
},
"signal": {
"_format": "int32",
"description": "Signal from the last termination of the container",
"type": "integer"
},
"startedAt": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time at which previous execution of the container started"
}
},
"required": [
"exitCode"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateWaiting": {
"description": "ContainerStateWaiting is a waiting state of a container.",
"properties": {
"message": {
"description": "Message regarding why the container is not yet running.",
"type": "string"
},
"reason": {
"description": "(brief) reason the container is not yet running.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStatus": {
"description": "ContainerStatus contains details for the current status of this container.",
"properties": {
"containerID": {
"description": "Container's ID in the format 'docker://<container_id>'.",
"type": "string"
},
"image": {
"description": "The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images",
"type": "string"
},
"imageID": {
"description": "ImageID of the container's image.",
"type": "string"
},
"lastState": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerState",
"description": "Details about the container's last termination condition."
},
"name": {
"description": "This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.",
"type": "string"
},
"ready": {
"description": "Specifies whether the container has passed its readiness probe.",
"type": "boolean"
},
"restartCount": {
"_format": "int32",
"description": "The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.",
"type": "integer"
},
"started": {
"description": "Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.",
"type": "boolean"
},
"state": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerState",
"description": "Details about the container's current condition."
}
},
"required": [
"name",
"ready",
"restartCount",
"image",
"imageID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIProjection": {
"description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.",
"properties": {
"items": {
"description": "Items is a list of DownwardAPIVolume file",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector",
"description": "Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."
},
"mode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeSource": {
"description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "Items is a list of downward API volume file",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EmptyDirVolumeSource": {
"description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.",
"properties": {
"medium": {
"description": "What type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir",
"type": "string"
},
"sizeLimit": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity",
"description": "Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar": {
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVarSource": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EphemeralContainer": {
"description": "An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle",
"description": "Lifecycle is not allowed for ephemeral containers."
},
"livenessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"name": {
"description": "Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.",
"type": "string"
},
"ports": {
"description": "Ports are not allowed for ephemeral containers.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort"
},
"type": "array"
},
"readinessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"resources": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements",
"description": "Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod."
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext",
"description": "SecurityContext is not allowed for ephemeral containers."
},
"startupProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"targetContainerName": {
"description": "If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.",
"type": "string"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction": {
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FCVolumeSource": {
"description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"lun": {
"_format": "int32",
"description": "Optional: FC target lun number",
"type": "integer"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"targetWWNs": {
"description": "Optional: FC target worldwide names (WWNs)",
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"description": "Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlexVolumeSource": {
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.",
"properties": {
"driver": {
"description": "Driver is the name of the driver to use for this volume.",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Extra command options if any.",
"type": "object"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts."
}
},
"required": [
"driver"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlockerVolumeSource": {
"description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.",
"properties": {
"datasetName": {
"description": "Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated",
"type": "string"
},
"datasetUUID": {
"description": "UUID of the dataset. This is unique identifier of a Flocker dataset",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GCEPersistentDiskVolumeSource": {
"description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"partition": {
"_format": "int32",
"description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "integer"
},
"pdName": {
"description": "Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GitRepoVolumeSource": {
"description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.",
"properties": {
"directory": {
"description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.",
"type": "string"
},
"repository": {
"description": "Repository URL",
"type": "string"
},
"revision": {
"description": "Commit hash for the specified revision.",
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GlusterfsVolumeSource": {
"description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"endpoints": {
"description": "EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"path": {
"description": "Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction": {
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPHeader": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler": {
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostAlias": {
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostPathVolumeSource": {
"description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
},
"type": {
"description": "Type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ISCSIVolumeSource": {
"description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.",
"properties": {
"chapAuthDiscovery": {
"description": "whether support iSCSI Discovery CHAP authentication",
"type": "boolean"
},
"chapAuthSession": {
"description": "whether support iSCSI Session CHAP authentication",
"type": "boolean"
},
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi",
"type": "string"
},
"initiatorName": {
"description": "Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.",
"type": "string"
},
"iqn": {
"description": "Target iSCSI Qualified Name.",
"type": "string"
},
"iscsiInterface": {
"description": "iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).",
"type": "string"
},
"lun": {
"_format": "int32",
"description": "iSCSI Target Lun number.",
"type": "integer"
},
"portals": {
"description": "iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "CHAP Secret for iSCSI target and initiator authentication"
},
"targetPortal": {
"description": "iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "The key to project.",
"type": "string"
},
"mode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"path": {
"description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle": {
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NFSVolumeSource": {
"description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "boolean"
},
"server": {
"description": "Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeAffinity": {
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelector": {
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement": {
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "The label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
"type": "string"
},
"values": {
"description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm": {
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector": {
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimVolumeSource": {
"description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).",
"properties": {
"claimName": {
"description": "ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims",
"type": "string"
},
"readOnly": {
"description": "Will force the ReadOnly setting in VolumeMounts. Default false.",
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PhotonPersistentDiskVolumeSource": {
"description": "Represents a Photon Controller persistent disk resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"pdID": {
"description": "ID that identifies Photon Controller persistent disk",
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Pod": {
"description": "Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"Pod"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSpec",
"description": "Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
},
"status": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodStatus",
"description": "Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
}
},
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "",
"kind": "Pod",
"version": "v1"
}
]
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinity": {
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm": {
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaces": {
"description": "namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAntiAffinity": {
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodCondition": {
"description": "PodCondition contains details for the current condition of this pod.",
"properties": {
"lastProbeTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Last time we probed the condition."
},
"lastTransitionTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Last time the condition transitioned from one status to another."
},
"message": {
"description": "Human-readable message indicating details about last transition.",
"type": "string"
},
"reason": {
"description": "Unique, one-word, CamelCase reason for the condition's last transition.",
"type": "string"
},
"status": {
"description": "Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions",
"type": "string"
},
"type": {
"description": "Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions",
"type": "string"
}
},
"required": [
"type",
"status"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfig": {
"description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.",
"properties": {
"nameservers": {
"description": "A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.",
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"description": "A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfigOption"
},
"type": "array"
},
"searches": {
"description": "A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfigOption": {
"description": "PodDNSConfigOption defines DNS resolver options of a pod.",
"properties": {
"name": {
"description": "Required.",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodIP": {
"description": "IP address information for entries in the (plural) PodIPs field. Each entry includes:\n IP: An IP address allocated to the pod. Routable at least within the cluster.",
"properties": {
"ip": {
"description": "ip is an IP address (IPv4 or IPv6) assigned to the pod",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodReadinessGate": {
"description": "PodReadinessGate contains the reference to a pod condition",
"properties": {
"conditionType": {
"description": "ConditionType refers to a condition in the pod's condition list with matching type.",
"type": "string"
}
},
"required": [
"conditionType"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSecurityContext": {
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"_format": "int64",
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified defaults to \"Always\".",
"type": "string"
},
"runAsGroup": {
"_format": "int64",
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"_format": "int64",
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"_format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSpec": {
"description": "PodSpec is a description of a pod.",
"properties": {
"activeDeadlineSeconds": {
"_format": "int64",
"description": "Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.",
"type": "integer"
},
"affinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Affinity",
"description": "If specified, the pod's scheduling constraints"
},
"automountServiceAccountToken": {
"description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
"type": "boolean"
},
"containers": {
"description": "List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"dnsConfig": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfig",
"description": "Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy."
},
"dnsPolicy": {
"description": "Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.",
"type": "string"
},
"enableServiceLinks": {
"description": "EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.",
"type": "boolean"
},
"ephemeralContainers": {
"description": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EphemeralContainer"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"hostAliases": {
"description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostAlias"
},
"type": "array",
"x-kubernetes-patch-merge-key": "ip",
"x-kubernetes-patch-strategy": "merge"
},
"hostIPC": {
"description": "Use the host's ipc namespace. Optional: Default to false.",
"type": "boolean"
},
"hostNetwork": {
"description": "Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.",
"type": "boolean"
},
"hostPID": {
"description": "Use the host's pid namespace. Optional: Default to false.",
"type": "boolean"
},
"hostname": {
"description": "Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.",
"type": "string"
},
"imagePullSecrets": {
"description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"initContainers": {
"description": "List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"nodeName": {
"description": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": "object"
},
"overhead": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.",
"type": "object"
},
"preemptionPolicy": {
"description": "PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.",
"type": "string"
},
"priority": {
"_format": "int32",
"description": "The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.",
"type": "integer"
},
"priorityClassName": {
"description": "If specified, indicates the pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.",
"type": "string"
},
"readinessGates": {
"description": "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodReadinessGate"
},
"type": "array"
},
"restartPolicy": {
"description": "Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy",
"type": "string"
},
"runtimeClassName": {
"description": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.",
"type": "string"
},
"schedulerName": {
"description": "If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSecurityContext",
"description": "SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field."
},
"serviceAccount": {
"description": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.",
"type": "string"
},
"serviceAccountName": {
"description": "ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "string"
},
"shareProcessNamespace": {
"description": "Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.",
"type": "boolean"
},
"subdomain": {
"description": "If specified, the fully qualified Pod hostname will be \"<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>\". If not specified, the pod will not have a domainname at all.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"_format": "int64",
"description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.",
"type": "integer"
},
"tolerations": {
"description": "If specified, the pod's tolerations.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TopologySpreadConstraint"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"topologyKey",
"whenUnsatisfiable"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "topologyKey",
"x-kubernetes-patch-strategy": "merge"
},
"volumes": {
"description": "List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Volume"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge,retainKeys"
}
},
"required": [
"containers"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodStatus": {
"description": "PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.",
"properties": {
"conditions": {
"description": "Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodCondition"
},
"type": "array",
"x-kubernetes-patch-merge-key": "type",
"x-kubernetes-patch-strategy": "merge"
},
"containerStatuses": {
"description": "The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStatus"
},
"type": "array"
},
"ephemeralContainerStatuses": {
"description": "Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStatus"
},
"type": "array"
},
"hostIP": {
"description": "IP address of the host to which the pod is assigned. Empty if not yet scheduled.",
"type": "string"
},
"initContainerStatuses": {
"description": "The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStatus"
},
"type": "array"
},
"message": {
"description": "A human readable message indicating details about why the pod is in this condition.",
"type": "string"
},
"nominatedNodeName": {
"description": "nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.",
"type": "string"
},
"phase": {
"description": "The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:\n\nPending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.\n\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase",
"type": "string"
},
"podIP": {
"description": "IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.",
"type": "string"
},
"podIPs": {
"description": "podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodIP"
},
"type": "array",
"x-kubernetes-patch-merge-key": "ip",
"x-kubernetes-patch-strategy": "merge"
},
"qosClass": {
"description": "The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md",
"type": "string"
},
"reason": {
"description": "A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'",
"type": "string"
},
"startTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PortworxVolumeSource": {
"description": "PortworxVolumeSource represents a Portworx volume resource.",
"properties": {
"fsType": {
"description": "FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"volumeID": {
"description": "VolumeID uniquely identifies a Portworx volume",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PreferredSchedulingTerm": {
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"_format": "int32",
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"_format": "int32",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"_format": "int32",
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"type": "integer"
},
"periodSeconds": {
"_format": "int32",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"type": "integer"
},
"successThreshold": {
"_format": "int32",
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"timeoutSeconds": {
"_format": "int32",
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"type": "integer"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ProjectedVolumeSource": {
"description": "Represents a projected volume source",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"sources": {
"description": "list of volume projections",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeProjection"
},
"type": "array"
}
},
"required": [
"sources"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_QuobyteVolumeSource": {
"description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
"properties": {
"group": {
"description": "Group to map volume access to Default is no group",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.",
"type": "boolean"
},
"registry": {
"description": "Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes",
"type": "string"
},
"tenant": {
"description": "Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin",
"type": "string"
},
"user": {
"description": "User to map volume access to Defaults to serivceaccount user",
"type": "string"
},
"volume": {
"description": "Volume is a string that references an already created Quobyte volume by name.",
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_RBDVolumeSource": {
"description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd",
"type": "string"
},
"image": {
"description": "The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"keyring": {
"description": "Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"monitors": {
"description": "A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"description": "The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
},
"user": {
"description": "The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector": {
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ScaleIOVolumeSource": {
"description": "ScaleIOVolumeSource represents a persistent ScaleIO volume",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\".",
"type": "string"
},
"gateway": {
"description": "The host address of the ScaleIO API Gateway.",
"type": "string"
},
"protectionDomain": {
"description": "The name of the ScaleIO Protection Domain for the configured storage.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail."
},
"sslEnabled": {
"description": "Flag to enable/disable SSL communication with Gateway, default false",
"type": "boolean"
},
"storageMode": {
"description": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.",
"type": "string"
},
"storagePool": {
"description": "The ScaleIO Storage Pool associated with the protection domain.",
"type": "string"
},
"system": {
"description": "The name of the storage system as configured in ScaleIO.",
"type": "string"
},
"volumeName": {
"description": "The name of a volume already created in the ScaleIO system that is associated with this volume source.",
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretEnvSource": {
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretKeySelector": {
"description": "SecretKeySelector selects a key of a Secret.",
"properties": {
"key": {
"description": "The key of the secret to select from. Must be a valid secret key.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretProjection": {
"description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.",
"properties": {
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretVolumeSource": {
"description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"optional": {
"description": "Specify whether the Secret or its keys must be defined",
"type": "boolean"
},
"secretName": {
"description": "Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"_format": "int64",
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"_format": "int64",
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"windowsOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ServiceAccountTokenProjection": {
"description": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).",
"properties": {
"audience": {
"description": "Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.",
"type": "string"
},
"expirationSeconds": {
"_format": "int64",
"description": "ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.",
"type": "integer"
},
"path": {
"description": "Path is the path relative to the mount point of the file to project the token into.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_StorageOSVolumeSource": {
"description": "Represents a StorageOS persistent volume resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted."
},
"volumeName": {
"description": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.",
"type": "string"
},
"volumeNamespace": {
"description": "VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Sysctl": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction": {
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Toleration": {
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"_format": "int64",
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TopologySpreadConstraint": {
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"_format": "int32",
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. It's the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. It's a required field. Default value is 1 and 0 is not allowed.",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as \"Unsatisfiable\" if and only if placing incoming pod on any topology violates \"MaxSkew\". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Volume": {
"description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.",
"properties": {
"awsElasticBlockStore": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AWSElasticBlockStoreVolumeSource",
"description": "AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"
},
"azureDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureDiskVolumeSource",
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."
},
"azureFile": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureFileVolumeSource",
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod."
},
"cephfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CephFSVolumeSource",
"description": "CephFS represents a Ceph FS mount on the host that shares a pod's lifetime"
},
"cinder": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CinderVolumeSource",
"description": "Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"
},
"configMap": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapVolumeSource",
"description": "ConfigMap represents a configMap that should populate this volume"
},
"csi": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CSIVolumeSource",
"description": "CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature)."
},
"downwardAPI": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeSource",
"description": "DownwardAPI represents downward API about the pod that should populate this volume"
},
"emptyDir": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EmptyDirVolumeSource",
"description": "EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"
},
"fc": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FCVolumeSource",
"description": "FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod."
},
"flexVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlexVolumeSource",
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin."
},
"flocker": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlockerVolumeSource",
"description": "Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running"
},
"gcePersistentDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GCEPersistentDiskVolumeSource",
"description": "GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"
},
"gitRepo": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GitRepoVolumeSource",
"description": "GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container."
},
"glusterfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GlusterfsVolumeSource",
"description": "Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md"
},
"hostPath": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostPathVolumeSource",
"description": "HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"
},
"iscsi": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ISCSIVolumeSource",
"description": "ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md"
},
"name": {
"description": "Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"nfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NFSVolumeSource",
"description": "NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"
},
"persistentVolumeClaim": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimVolumeSource",
"description": "PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
},
"photonPersistentDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PhotonPersistentDiskVolumeSource",
"description": "PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"
},
"portworxVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PortworxVolumeSource",
"description": "PortworxVolume represents a portworx volume attached and mounted on kubelets host machine"
},
"projected": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ProjectedVolumeSource",
"description": "Items for all in one resources secrets, configmaps, and downward API"
},
"quobyte": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_QuobyteVolumeSource",
"description": "Quobyte represents a Quobyte mount on the host that shares a pod's lifetime"
},
"rbd": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_RBDVolumeSource",
"description": "RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md"
},
"scaleIO": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ScaleIOVolumeSource",
"description": "ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."
},
"secret": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretVolumeSource",
"description": "Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"
},
"storageos": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_StorageOSVolumeSource",
"description": "StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."
},
"vsphereVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VsphereVirtualDiskVolumeSource",
"description": "VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice": {
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"properties": {
"devicePath": {
"description": "devicePath is the path inside of the container that the device will be mapped to.",
"type": "string"
},
"name": {
"description": "name must match the name of a persistentVolumeClaim in the pod",
"type": "string"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount": {
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeProjection": {
"description": "Projection that may be projected along with other supported volume types",
"properties": {
"configMap": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapProjection",
"description": "information about the configMap data to project"
},
"downwardAPI": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIProjection",
"description": "information about the downwardAPI data to project"
},
"secret": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretProjection",
"description": "information about the secret data to project"
},
"serviceAccountToken": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ServiceAccountTokenProjection",
"description": "information about the serviceAccountToken data to project"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VsphereVirtualDiskVolumeSource": {
"description": "Represents a vSphere volume resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"storagePolicyID": {
"description": "Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.",
"type": "string"
},
"storagePolicyName": {
"description": "Storage Policy Based Management (SPBM) profile name.",
"type": "string"
},
"volumePath": {
"description": "Path that identifies vSphere volume vmdk",
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm": {
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"_format": "int32",
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector": {
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelectorRequirement": {
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ListMeta": {
"description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
"properties": {
"continue": {
"description": "continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.",
"type": "string"
},
"remainingItemCount": {
"_format": "int64",
"description": "remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.",
"type": "integer"
},
"resourceVersion": {
"description": "String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "selfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1",
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type."
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"time": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": "object"
},
"clusterName": {
"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
"type": "string"
},
"creationTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"deletionGracePeriodSeconds": {
"_format": "int64",
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"_format": "int64",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "PodList is a list of Pods.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"enum": [
"v1"
],
"type": [
"string",
"null"
]
},
"items": {
"description": "List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Pod"
},
"type": [
"array",
"null"
]
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"PodList"
],
"type": [
"string",
"null"
]
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ListMeta",
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
}
},
"required": [
"items"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "",
"kind": "PodList",
"version": "v1"
}
]
} | kb_707_Normalized |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"buys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"listings": {
"type": "number"
},
"unit_price": {
"type": "number"
},
"quantity": {
"type": "number"
}
},
"required": [
"listings",
"unit_price",
"quantity"
]
}
},
"sells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"listings": {
"type": "number"
},
"unit_price": {
"type": "number"
},
"quantity": {
"type": "number"
}
},
"required": [
"listings",
"unit_price",
"quantity"
]
}
}
},
"required": [
"id",
"buys",
"sells"
]
},
"properties": {},
"additionalProperties": false
} | o45159 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "EbolaCallCentreUser",
"description": "An Ebola call centre CouchDB user",
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"_rev": {
"type": "string"
},
"password_scheme": {
"type": "string"
},
"iterations": {
"type": "integer"
},
"name": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"details": {
"fullName": {
"type": "string"
},
"role": {
"type": "string"
},
"app": {
"type": "string"
}
},
"type": {
"type": "string"
},
"doc_type": {
"type": "string"
},
"derived_key": {
"type": "string"
},
"salt": {
"type": "string"
},
"locations": {
"$ref": "#/definitions/locations"
}
},
"definitions": {
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"level": {
"type": "integer"
},
"default": {
"type": "boolean"
}
}
}
}
},
"required": [
"_id",
"password_scheme",
"name",
"type",
"doc_type",
"derived_key",
"salt"
]
} | o37721 |
{
"properties": {
"PayloadContent": {
"default": {
"Key Type": "RSA",
"Keysize": 1024,
"Retries": 3,
"RetryDelay": 10
},
"description": "This dictionary contains the payload contents",
"properties": {
"CAFingerprint": {
"description": "Optional. The fingerprint of the Certificate Authority certificate.",
"type": "string"
},
"Challenge": {
"description": "Used as the pre-shared secret for automatic enrollment",
"type": "string"
},
"GetCACaps": {
"description": "If you add a dictionary with the key GetCACaps, the device uses the strings you provide as the authoritative source of information about the capabilities of your CA.",
"properties": {},
"type": "object"
},
"KeyType": {
"default": "RSA",
"description": "Optional. Currently always \"RSA\".",
"enum": [
"RSA"
],
"type": "string"
},
"KeyUsage": {
"default": 0,
"description": "A bitmask indicating the use of the ky. 1 - signing, 4 - encryption, 5 - signing and encryption",
"type": "number"
},
"Keysize": {
"default": 1024,
"description": "Key size in bits",
"enum": [
1024,
2048
],
"type": "number"
},
"Name": {
"description": "Optional. Any string that is understood by the SCEP server. For example, it could be a domain name like example.org. If a certificate authority has multiple CA certificates this field can be used to distinguish which is required.",
"type": "string"
},
"Retries": {
"default": 3,
"description": "The number of times the device should retry if the server sends a PENDING response",
"type": "number"
},
"RetryDelay": {
"default": 10,
"description": "The number of seconds to wait between subsequent retries. The first retry is attempted without this delay",
"type": "number"
},
"Subject": {
"description": "The representation of a X.500 name represented as an array of OID and value. OIDs can be represented as dotted numbers, with shortcuts for country (C), locality (L), state (ST), organization (O), organizational unit (OU), and common name (CN).",
"items": {
"description": "This array holds another array which holds an OID value pair",
"items": {
"description": "An array representing an OID and value pair.",
"items": {
"description": "One item in the array representing a pair of OID and value",
"type": "string"
},
"type": "array"
},
"type": "array"
},
"type": "array"
},
"SubjectAltName": {
"description": "Specifies the Subject Alt Name for the certificate",
"properties": {
"dNSName": {
"description": "DNS Name",
"type": "string"
},
"ntPrincipalName": {
"description": "NT Principal Name",
"type": "string"
},
"rfc822Name": {
"description": "RFC 822 (email address) string",
"type": "string"
},
"uniformResourceIdentifier": {
"description": "Uniform Resource Indentifier",
"type": "string"
}
},
"type": "object"
},
"URL": {
"description": "The base URL for the SCEP server",
"type": "string"
}
},
"type": "object"
},
"PayloadDescription": {
"default": "Configures SCEP settings",
"description": "Description of the payload",
"type": "string"
},
"PayloadDisplayName": {
"default": "SCEP",
"description": "Name of the payload",
"type": "string"
},
"PayloadIdentifier": {
"default": "com.apple.security.scep",
"description": "A unique identifier for the payload, dot-delimited. Usually root PayloadIdentifier+subidentifier",
"type": "string"
},
"PayloadOrganization": {
"description": "This value describes the issuing organization of the profile, as displayed to the user",
"type": "string"
},
"PayloadType": {
"default": "com.apple.security.scep",
"description": "The type of the payload, a reverse dns string",
"type": "string"
},
"PayloadUUID": {
"default": "",
"description": "Unique identifier for the payload (format 01234567-89AB-CDEF-0123-456789ABCDEF)",
"pattern": "^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$",
"type": "string"
},
"PayloadVersion": {
"default": 1,
"description": "The version of the whole configuration profile.",
"type": "number"
}
},
"title": "com.apple.security.scep",
"type": "object"
} | o61632 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"meta": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"type": {
"type": "string",
"enum": [
"EiffelTestCaseCanceledEvent"
]
},
"version": {
"type": "string",
"enum": [
"3.0.0"
],
"default": "3.0.0"
},
"time": {
"type": "integer"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"type": "object",
"properties": {
"domainId": {
"type": "string"
},
"host": {
"type": "string"
},
"name": {
"type": "string"
},
"serializer": {
"type": "string",
"pattern": "^pkg:"
},
"uri": {
"type": "string"
}
},
"additionalProperties": false
},
"security": {
"type": "object",
"properties": {
"authorIdentity": {
"type": "string"
},
"integrityProtection": {
"type": "object",
"properties": {
"signature": {
"type": "string"
},
"alg": {
"type": "string",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
]
},
"publicKey": {
"type": "string"
}
},
"required": [
"signature",
"alg"
],
"additionalProperties": false
},
"sequenceProtection": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sequenceName": {
"type": "string"
},
"position": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"sequenceName",
"position"
]
}
}
},
"additionalProperties": false,
"required": [
"authorIdentity"
]
}
},
"required": [
"id",
"type",
"version",
"time"
],
"additionalProperties": false
},
"data": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"customData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {}
},
"required": [
"key",
"value"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"target": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
}
},
"required": [
"type",
"target"
],
"additionalProperties": false
}
}
},
"required": [
"meta",
"data",
"links"
],
"additionalProperties": false
} | o5395 |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_apps_v1_ControllerRevision": {
"description": "ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"data": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_runtime_RawExtension",
"description": "Data is the serialized representation of the state."
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"ControllerRevision"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"revision": {
"_format": "int64",
"description": "Revision indicates the revision of the state represented by Data.",
"type": "integer"
}
},
"required": [
"revision"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "apps",
"kind": "ControllerRevision",
"version": "v1"
}
]
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ListMeta": {
"description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
"properties": {
"continue": {
"description": "continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.",
"type": "string"
},
"remainingItemCount": {
"_format": "int64",
"description": "remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.",
"type": "integer"
},
"resourceVersion": {
"description": "String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "selfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1",
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type."
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"time": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": "object"
},
"clusterName": {
"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
"type": "string"
},
"creationTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"deletionGracePeriodSeconds": {
"_format": "int64",
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"_format": "int64",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_runtime_RawExtension": {
"description": "RawExtension is used to hold extensions in external versions.\n\nTo use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.\n\n// Internal package: type MyAPIObject struct {\n\truntime.TypeMeta `json:\",inline\"`\n\tMyPlugin runtime.Object `json:\"myPlugin\"`\n} type PluginA struct {\n\tAOption string `json:\"aOption\"`\n}\n\n// External package: type MyAPIObject struct {\n\truntime.TypeMeta `json:\",inline\"`\n\tMyPlugin runtime.RawExtension `json:\"myPlugin\"`\n} type PluginA struct {\n\tAOption string `json:\"aOption\"`\n}\n\n// On the wire, the JSON will look something like this: {\n\t\"kind\":\"MyAPIObject\",\n\t\"apiVersion\":\"v1\",\n\t\"myPlugin\": {\n\t\t\"kind\":\"PluginA\",\n\t\t\"aOption\":\"foo\",\n\t},\n}\n\nSo what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)",
"type": "object"
}
},
"description": "ControllerRevisionList is a resource containing a list of ControllerRevision objects.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"enum": [
"apps/v1"
],
"type": [
"string",
"null"
]
},
"items": {
"description": "Items is the list of ControllerRevisions",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_apps_v1_ControllerRevision"
},
"type": [
"array",
"null"
]
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"ControllerRevisionList"
],
"type": [
"string",
"null"
]
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ListMeta",
"description": "More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
}
},
"required": [
"items"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "apps",
"kind": "ControllerRevisionList",
"version": "v1"
}
]
} | kb_139_Normalized |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerState": {
"description": "ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.",
"properties": {
"running": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateRunning",
"description": "Details about a running container"
},
"terminated": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateTerminated",
"description": "Details about a terminated container"
},
"waiting": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateWaiting",
"description": "Details about a waiting container"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateRunning": {
"description": "ContainerStateRunning is a running state of a container.",
"properties": {
"startedAt": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time at which the container was last (re-)started"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateTerminated": {
"description": "ContainerStateTerminated is a terminated state of a container.",
"properties": {
"containerID": {
"description": "Container's ID in the format 'docker://<container_id>'",
"type": "string"
},
"exitCode": {
"_format": "int32",
"description": "Exit status from the last termination of the container",
"type": "integer"
},
"finishedAt": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time at which the container last terminated"
},
"message": {
"description": "Message regarding the last termination of the container",
"type": "string"
},
"reason": {
"description": "(brief) reason from the last termination of the container",
"type": "string"
},
"signal": {
"_format": "int32",
"description": "Signal from the last termination of the container",
"type": "integer"
},
"startedAt": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time at which previous execution of the container started"
}
},
"required": [
"exitCode"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerStateWaiting": {
"description": "ContainerStateWaiting is a waiting state of a container.",
"properties": {
"message": {
"description": "Message regarding why the container is not yet running.",
"type": "string"
},
"reason": {
"description": "(brief) reason the container is not yet running.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
}
},
"description": "ContainerStatus contains details for the current status of this container.",
"properties": {
"containerID": {
"description": "Container's ID in the format 'docker://<container_id>'.",
"type": [
"string",
"null"
]
},
"image": {
"description": "The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images",
"type": [
"string",
"null"
]
},
"imageID": {
"description": "ImageID of the container's image.",
"type": [
"string",
"null"
]
},
"lastState": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerState",
"description": "Details about the container's last termination condition."
},
"name": {
"description": "This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.",
"type": [
"string",
"null"
]
},
"ready": {
"description": "Specifies whether the container has passed its readiness probe.",
"type": [
"boolean",
"null"
]
},
"restartCount": {
"description": "The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"started": {
"description": "Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined.",
"type": [
"boolean",
"null"
]
},
"state": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerState",
"description": "Details about the container's current condition."
}
},
"required": [
"name",
"ready",
"restartCount",
"image",
"imageID"
],
"type": "object"
} | kb_134_Normalized |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the address.json"
},
"type": {
"type": "string",
"description": "The json_api type for any address.json",
"pattern": "^addresses$"
},
"attributes": {
"type": "object",
"properties": {
"meta_attributes": {
"type": "object",
"description": "Description for meta_attributes"
},
"customer_account_id": {
"type": "number",
"description": "Description for customer_account_id"
},
"first_name": {
"type": "string",
"description": "Description for first_name"
},
"last_name": {
"type": "string",
"description": "Description for last_name"
},
"middle_names": {
"type": "string",
"description": "Description for middle_names"
},
"address_line_1": {
"type": "string",
"description": "Description for address_line_1"
},
"address_line_2": {
"type": "string",
"description": "Description for address_line_2"
},
"address_line_3": {
"type": "string",
"description": "Description for address_line_3"
},
"city": {
"type": "string",
"description": "Description for city"
},
"state": {
"type": "string",
"description": "Description for state"
},
"postcode": {
"type": "string",
"description": "Description for postcode"
},
"country": {
"type": "string",
"description": "Description for country"
},
"preferred_shipping": {
"type": "boolean",
"description": "Description for preferred_shipping"
},
"preferred_billing": {
"type": "boolean",
"description": "Description for preferred_billing"
}
}
},
"relationships": {
"type": "object",
"properties": {
"customer_account": {
"type": "object",
"properties": {
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
},
"related": {
"type": "string"
}
},
"additionalProperties": false
},
"data": {
"type": "object",
"description": "The id and type form a pointer into the 'included' top level document property",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string"
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"additionalProperties": false
}
},
"definitions": {}
} | o75281 |
{
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"$tool": {
"const": "json2ts",
"description": "Must be set to json2ts.",
"type": "string"
},
"dist": {
"description": "The output file path (relative to the pwd), support .ts file.",
"type": "string"
},
"src": {
"description": "Input json files(Glob), relative to the pwd.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"$tool",
"src",
"dist"
],
"title": "json2ts Config",
"type": "object"
} | o39082 |
{
"properties": {
"PayloadDescription": {
"default": "Global HTTP Proxy",
"description": "Description of the payload",
"type": "string"
},
"PayloadDisplayName": {
"default": "Global HTTP Proxy",
"description": "Name of the payload",
"type": "string"
},
"PayloadIdentifier": {
"default": "com.apple.proxy.http.global",
"description": "A unique identifier for the payload, dot-delimited. Usually root PayloadIdentifier+subidentifier",
"type": "string"
},
"PayloadOrganization": {
"description": "This value describes the issuing organization of the profile, as displayed to the user",
"type": "string"
},
"PayloadType": {
"default": "com.apple.proxy.http.global",
"description": "The type of the payload, a reverse dns string",
"type": "string"
},
"PayloadUUID": {
"default": "",
"description": "Unique identifier for the payload (format 01234567-89AB-CDEF-0123-456789ABCDEF)",
"pattern": "^[0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12}$",
"type": "string"
},
"PayloadVersion": {
"default": 1,
"description": "The version of the whole configuration profile.",
"type": "number"
},
"ProxyCaptiveLoginAllowed": {
"default": false,
"description": "Proxy Bypass Allowed",
"type": "boolean"
},
"ProxyPACFallbackAllowed": {
"default": false,
"description": "Proxy PAC Fallback Allowed",
"type": "boolean"
},
"ProxyPACURL": {
"description": "Proxy PAC URL",
"type": "string"
},
"ProxyPassword": {
"description": "Proxy Password",
"type": "string"
},
"ProxyServer": {
"description": "Proxy Server",
"type": "string"
},
"ProxyServerPort": {
"description": "Proxy Server Port",
"type": "number"
},
"ProxyType": {
"default": "Manual",
"description": "Proxy Type",
"enum": [
"Manual",
"Auto"
],
"type": "string"
},
"ProxyUsername": {
"description": "Proxy Username",
"type": "string"
}
},
"title": "com.apple.proxy.http.global",
"type": "object"
} | o61623 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"validator": {
"type": "string"
}
},
"required": [
"name",
"validator"
]
},
"client": {
"type": "object",
"properties": {
"backend": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"class": {
"type": "string"
},
"host": {
"type": "string"
},
"protocol": {
"type": "string"
}
},
"required": [
"name",
"class",
"host",
"protocol"
]
},
"path_processor": {
"type": "object",
"properties": {
"class": {
"type": "string"
},
"params": {
"type": "object",
"properties": {}
}
},
"required": [
"class",
"params"
]
},
"tile_processor": {
"description": "Required if ingest_job.ingest_type == tile",
"type": "object",
"properties": {
"class": {
"type": "string"
},
"params": {
"type": "object",
"properties": {}
}
},
"required": [
"class",
"params"
]
},
"chunk_processor": {
"description": "Required if ingest_job.ingest_type == volumetric",
"type": "object",
"properties": {
"class": {
"type": "string"
},
"params": {
"type": "object",
"properties": {}
}
},
"required": [
"class",
"params"
]
}
},
"required": [
"backend",
"path_processor"
]
},
"database": {
"type": "object",
"properties": {
"collection": {
"type": "string"
},
"experiment": {
"type": "string"
},
"channel": {
"type": "string"
}
},
"required": [
"collection",
"experiment",
"channel"
]
},
"ingest_job": {
"type": "object",
"properties": {
"resolution": {
"type": "integer"
},
"ingest_type": {
"type": "string",
"enum": [
"tile",
"volumetric"
]
},
"extent": {
"type": "object",
"properties": {
"x": {
"type": "array",
"items": {
"type": "integer"
}
},
"y": {
"type": "array",
"items": {
"type": "integer"
}
},
"z": {
"type": "array",
"items": {
"type": "integer"
}
},
"t": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"x",
"y",
"z",
"t"
]
},
"tile_size": {
"description": "Required if ingest_type == tile",
"type": "object",
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
},
"z": {
"type": "integer"
},
"t": {
"type": "integer"
}
},
"required": [
"x",
"y",
"z",
"t"
]
},
"chunk_size": {
"description": "Required if ingest_type == volumetric",
"type": "object",
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
},
"z": {
"type": "integer"
}
},
"required": [
"x",
"y",
"z"
]
}
},
"required": [
"ingest_type",
"resolution",
"extent"
]
}
},
"required": [
"schema",
"client",
"database",
"ingest_job"
]
} | o50114 |
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"pushdataentry": {
"type": "object",
"title": "pushdataentry",
"properties": {
"url": {
"type": "string",
"description": "full URL of the middleware to push data to e.g. http://127.0.0.1/push/data.json"
}
},
"required": [
"url"
]
},
"local": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "should we start the local HTTPd for serving live readings?"
},
"port": {
"type": "integer",
"default": 8080,
"description": "the TCP port for the local HTTPd"
},
"index": {
"type": "boolean",
"description": "should we provide a index listing of available channels if no UUID was requested?"
},
"timeout": {
"type": "integer"
},
"buffer": {
"type": "integer"
}
},
"required": [
"enabled"
]
},
"channel": {
"type": "object",
"title": "channel",
"properties": {
"uuid": {
"type": "string",
"description": "uuid of this channel towards the middleware"
},
"identifier": {
"type": "string",
"description": "identifier of this channel from the meter. E.g. 1-0:1.8.0"
},
"api": {
"type": "string",
"enum": [
"volkszaehler",
"mysmartgrid",
"null"
],
"default": "volkszaehler",
"description": "middleware api to be used. Defaults to volkszaehler.org"
},
"middleware": {
"type": "string",
"default": "http://localhost/middleware.php",
"description": "path/url to the api/middleware"
},
"secretKey": {
"type": "string",
"description": "secret key to use to talk to MySmartGrid api."
},
"type": {
"type": "string",
"enum": [
"device",
"sensor"
],
"default": "device",
"description": "type of connected meter. Only needed for MySmartGrid api."
},
"scaler": {
"type": "integer",
"default": 1,
"description": "scaling factor to use. Only needed for MySmartGrid api."
},
"aggmode": {
"type": "string",
"enum": [
"avg",
"max",
"sum",
"none"
],
"description": "Mittelwert fuer Leistung, MAX fuer Zaehler, SUM fuer Counter",
"default": "none"
},
"duplicates": {
"type": "integer",
"minimum": 0,
"default": 0,
"description": "default 0 (send duplicate values), >0 = send duplicate values only each <duplicates> seconds. Activate only for abs. counter values (Zaehlerstaende) and not for impulses!"
}
},
"required": [
"uuid",
"identifier"
]
},
"meter": {
"type": "object",
"title": "meter",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable or disable this meter. Disabled meter will be ignored.",
"default": false
},
"allowskip": {
"type": "boolean",
"description": "if enabled, errors when opening meter will lead to meter being ignored",
"default": false
},
"interval": {
"type": "integer",
"description": "delay in secs between queries to the meter",
"default": -1
},
"aggtime": {
"type": "integer",
"description": "aggregate all signals and give one update to middleware every <aggtime> seconds",
"default": -1
},
"aggfixedinterval": {
"type": "boolean",
"description": "round all timestamps to middleware to nearest aggtime",
"default": false
},
"channels": {
"$ref": "#/definitions/channels"
}
},
"required": []
},
"meterInvalid": {
"title": "invalid config for a meter. Choose any of the supported ones.",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"invalid"
]
}
}
}
]
},
"meterS0": {
"title": "S0 based meter",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"s0"
]
},
"device": {
"type": "string",
"description": "UART device the meter is connected to. E.g. /dev/ttyUSB0"
},
"gpio": {
"type": "integer",
"default": -1,
"description": "Number of GPIO port to be used. If this is set >-1 then device is ignored."
},
"mmap": {
"type": "string",
"default": "",
"description": "For gpio based devices and high frequency signals (>5-10kHz on a rpi2) memory mapped gpio can be used. Currently only supported on Raspberry-Pi 1 or 2. Leads to a constant but high CPU load depending on nonblocking_delay value. MMAPed GPIO pins need to be configured manually as input pins.",
"enum": [
"",
"rpi1",
"rpi2"
]
},
"gpio_dir": {
"type": "integer",
"default": -1,
"description": "Number of GPIO port to be used as directional pin. If this pin is used and active Impulses_neg instead of Impulses is returned. Keep to -1 if unsure about the purpose."
},
"configureGPIO": {
"type": "boolean",
"default": true,
"description": "If true then vzlogger will export, configure,... the GPIO port. Needs proper access rights to /sys/class/gpio/."
},
"resolution": {
"type": "integer",
"default": 1000,
"description": "number of impulses per kWh"
},
"send_zero": {
"type": "boolean",
"default": false,
"description": "If active/true send data once a second even if no impulses have been received. Use aggregation is this case to reduce frequency."
},
"debounce_delay": {
"type": "integer",
"default": 30,
"description": "Delay in ms until the next edge is detected"
},
"nonblocking_delay": {
"type": "integer",
"default": 100000,
"description": "Delay in ns for polling/non-blocking interface. On an rpi2 e.g. 5000 can be used to detect up to 30kHz signals with mmap active."
}
},
"required": [
"protocol",
"device"
]
}
]
},
"meterD0": {
"title": "D0 based meter",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"d0"
]
},
"device": {
"type": "string",
"description": "device the meter is connected to. E.g. /dev/ttyUSB0"
},
"host": {
"type": "string",
"description": "ip addr of the meter (if not directly connected)"
},
"dump_file": {
"type": "string",
"description": "path/filename of the file for the serial dump"
},
"pullseq": {
"type": "string",
"description": "sequence in hex to send to the meter before each read call. E.g. 2F3F210D0A"
},
"ackseq": {
"type": "string",
"description": "Reply sequence towards the meter. Should indicate the baud rate wanted. Will be send with initial baudrate. E.g. 063030300d0a for 300 baud. Use 'auto' to let vzlogger determine.",
"default": "auto"
},
"baudrate": {
"type": "integer",
"enum": [
50,
75,
110,
134,
150,
200,
300,
600,
1200,
1800,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
230400
],
"default": 300,
"description": "Baudrate to be used to for initial communication with the meter."
},
"baudrate_read": {
"type": "integer",
"enum": [
50,
75,
110,
134,
150,
200,
300,
600,
1200,
1800,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
230400
],
"default": 300,
"description": "Baudrate to be used after initial handshake (pullseq/answer/ackseq). Has to fit to ackseq. Will be determined automatically if ackseq 'auto' is used."
},
"parity": {
"type": "string",
"enum": [
"8n1",
"7n1",
"7e1",
"7o1"
],
"default": "7e1",
"description": "parity used for serial communication"
},
"wait_sync": {
"type": "string",
"enum": [
"end",
"off"
],
"default": "off",
"description": "Wait once for the sync pattern '!'. Intended for meters that start sending data automatically without pullseq."
},
"read_timeout": {
"type": "integer",
"default": 10,
"description": "Read timeout in secs. Data readout is considered finished if no state change after that timeout."
},
"baudrate_change_delay": {
"type": "integer",
"default": 0,
"description": "Delay in ms to apply before changing the baudrate. Defaults to 0 where tcdrain is used instead of a timeout."
}
}
}
]
},
"meterSML": {
"title": "SML based meter",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"sml"
]
},
"host": {
"type": "string",
"description": "ip addr of the meter (if not directly connected)"
},
"device": {
"type": "string",
"description": "device the meter is connected to. E.g. /dev/ttyUSB0"
},
"pullseq": {
"type": "string",
"description": "sequence in hex to send to the meter before each read call"
},
"baudrate": {
"type": "integer",
"enum": [
50,
75,
110,
134,
150,
200,
300,
600,
1200,
1800,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
230400
],
"default": 9600,
"description": "baudrate for serial communication"
},
"parity": {
"type": "string",
"enum": [
"8n1",
"7n1",
"7e1",
"7o1"
],
"default": "8n1",
"description": "parity used for serial communication"
}
}
}
]
},
"meterRandom": {
"title": "example meter returning random values",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"random"
]
},
"min": {
"type": "number",
"description": "minimum value (floating point) that will be returned. E.g. 0.0"
},
"max": {
"type": "number",
"description": "maximum value (floating point) that will be returned. E.g. 10.0"
}
}
}
]
},
"meterFile": {
"title": "meter extracting data from a given file",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"file"
]
},
"path": {
"type": "string",
"description": "file incl. path to be used for data extraction"
},
"format": {
"type": "string",
"description": "optional format string. Supports $v for value, $i for identifier and $t for timestamp. E.g. $i:$v. If empty just a value is read from each line of the file."
},
"rewind": {
"type": "boolean",
"description": "rewind the file handle at each read?",
"default": false
}
},
"required": [
"path"
]
}
]
},
"meterExec": {
"title": "meter extracting data from the output of a shell command/executable",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"exec"
]
},
"command": {
"type": "string",
"description": "Command to be executed. Only possible if running as non root. Output will be parsed."
},
"format": {
"type": "string",
"description": "optional format string. Supports $v for value, $i for identifier and $t for timestamp. E.g. $i:$v. If empty just a value is read from each line of the file."
}
},
"required": [
"command"
]
}
]
},
"meterFluksoV2": {
"title": "fluksov2 meter",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"fluksov2"
]
},
"fifo": {
"type": "string",
"description": "fifo to be used.",
"default": "/var/run/spid/delta/out"
}
},
"required": [
"fifo"
]
}
]
},
"meterW1therm": {
"title": "w1-therm / 1wire temperature sensors",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"w1therm"
]
}
}
}
]
},
"meterOMS": {
"title": "OMS / OMS (M-Bus) based devices",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"oms"
]
},
"device": {
"type": "string",
"description": "serial device the meter is connected to. E.g. /dev/ttyUSB0"
},
"baudrate": {
"type": "number",
"default": 9600,
"description": "Baudrate to use. Default to 9600."
},
"key": {
"type": "string",
"description": "AES key for the device in hex. Needs to be exactly 32 characters. E.g. 0102030405060708090a0b0c0d0e0f10"
},
"mbus_debug": {
"type": "boolean",
"default": false,
"description": "provide some more debug output on console by calling some libmbus debug functions"
}
},
"required": [
"device",
"key"
]
}
]
},
"meterOCRBB": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "id (obis-like) for this reading"
},
"scaler": {
"type": "integer",
"default": 0,
"description": "Scaling factor by 10^<scaler>. E.g. 0 = *1, -1 = *0.1, 2 = *100"
},
"digit": {
"type": "boolean",
"default": false,
"description": "a single digit is expected (thus the recognized value can only be within -9..9)"
}
}
},
"meterOCRBBInvalid": {
"title": "invalid bounding-box. Choose any of the supported ones.",
"allOf": [
{
"$ref": "#/definitions/meterOCRBB"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"invalid"
]
}
}
}
]
},
"meterOCRBBCircle": {
"title": "bounding-box with a circle",
"allOf": [
{
"$ref": "#/definitions/meterOCRBB"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"circle"
]
},
"circle": {
"type": "object",
"properties": {
"cx": {
"type": "integer",
"description": "x coordinate of the center of the circle (top-left corner is (0,0))"
},
"cy": {
"type": "integer",
"description": "y coordinate of the center of the circle"
},
"cr": {
"type": "integer",
"default": 10,
"description": "radius of the circle. 10 pixel minimum."
},
"offset": {
"type": "number",
"default": 0.0,
"description": "offset of this needle. E.g. if at 5.0 (2nd digit needle at zero) but this needle show ~4.6 enter offset 0.4."
}
}
}
}
}
]
},
"meterOCRBBBox": {
"title": "bounding-box with a rectangle",
"allOf": [
{
"$ref": "#/definitions/meterOCRBB"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"box"
]
},
"box": {
"type": "object",
"properties": {
"x1": {
"type": "integer",
"description": "left coordinate of the rectangle"
},
"y1": {
"type": "integer",
"description": "top coordinate of the rectangle"
},
"x2": {
"type": "integer",
"description": "right coordinate of the rectangle"
},
"y2": {
"type": "integer",
"description": "bottom coordinate of the rectangle"
}
}
}
}
}
]
},
"meterOCRRecognizer": {
"type": "object",
"properties": {
"boundingboxes": {
"oneOf": [
{
"$ref": "#/definitions/meterOCRBBInvalid"
},
{
"$ref": "#/definitions/meterOCRBBCircle"
},
{
"$ref": "#/definitions/meterOCRBBBox"
}
]
}
}
},
"meterOCRRecognizerInvalid": {
"title": "invalid recognizer. Choose any of the supported ones.",
"allOf": [
{
"$ref": "#/definitions/meterOCRRecognizer"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"invalid"
]
}
}
}
]
},
"meterOCRRecognizerNeedle": {
"title": "needle type recognizer",
"allOf": [
{
"$ref": "#/definitions/meterOCRRecognizer"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"needle"
]
},
"kernelColorString": {
"type": "string",
"description": "Color conversion 3x3 matrix. Default red channel only (2 -1 -1 0 0 0 0 0 0). First line channel red. Needles are detected for red color after matrix application. See leptonica:pixMultMatrixColor"
}
}
}
]
},
"meterOCRRecognizerBinary": {
"title": "binary (impulses) recognizer",
"allOf": [
{
"$ref": "#/definitions/meterOCRRecognizer"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"binary"
]
},
"kernelColorString": {
"type": "string",
"description": "Color conversion 3x3 matrix. Default red channel only (2 -1 -1 0 0 0 0 0 0). First line channel red. Rectangle/pixes are detected for red color after matrix application. See leptonica:pixMultMatrixColor"
}
}
}
]
},
"meterOCR": {
"title": "meter extracting data from images (meterOCR)",
"allOf": [
{
"$ref": "#/definitions/meter"
},
{
"properties": {
"protocol": {
"type": "string",
"enum": [
"ocr"
]
},
"impulses": {
"type": "integer",
"default": 0,
"description": "0 = report absolute values, >0 = report given impulses per unit"
},
"file": {
"type": "string",
"default": "/mnt/ramdisk/image.png",
"description": "filename of the image to be processed (or use v4l2_dev)"
},
"v4l2_dev": {
"type": "string",
"description": "v4l2 device name (e.g. /dev/video0). Keep empty if file based image should be used. Has preference over file."
},
"generate_debug_image": {
"type": "boolean",
"default": false,
"description": "generate debug images to ease configuration. Will be created in /run/vzlogger<nr>_debug.jpg for v4l2 or as <file>_debug.jpg if file based detection is used."
},
"rotate": {
"type": "number",
"default": 0.0,
"description": "angle in degree for rotation of the image. Positive angle turn clockwise."
},
"recognizer": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/definitions/meterOCRRecognizerInvalid"
},
{
"$ref": "#/definitions/meterOCRRecognizerNeedle"
},
{
"$ref": "#/definitions/meterOCRRecognizerBinary"
}
]
}
}
}
}
]
},
"channels": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/definitions/channel"
}
]
}
},
"meters": {
"type": "array",
"minItems": 1,
"items": {
"oneOf": [
{
"$ref": "#/definitions/meterInvalid"
},
{
"$ref": "#/definitions/meterS0"
},
{
"$ref": "#/definitions/meterD0"
},
{
"$ref": "#/definitions/meterSML"
},
{
"$ref": "#/definitions/meterRandom"
},
{
"$ref": "#/definitions/meterFile"
},
{
"$ref": "#/definitions/meterExec"
},
{
"$ref": "#/definitions/meterFluksoV2"
},
{
"$ref": "#/definitions/meterOCR"
},
{
"$ref": "#/definitions/meterOMS"
},
{
"$ref": "#/definitions/meterW1therm"
}
]
}
},
"push": {
"type": "array",
"minItems": 0,
"items": {
"oneOf": [
{
"$ref": "#/definitions/pushdataentry"
}
]
},
"description": "list of middlewares receiving push data (i.e. non aggregated live data in single http request)"
}
},
"type": "object",
"properties": {
"retry": {
"type": "integer",
"description": "How long to sleep between failed requests, in seconds"
},
"daemon": {
"type": "boolean",
"default": "true",
"description": "Enable daemon mode"
},
"verbosity": {
"type": "integer",
"enum": [
0,
5,
10,
15
],
"description": "0 = log_error or log-warning, 5 = log_info, 10 = log-debug, 15 = log_finest",
"default": 0
},
"log": {
"type": "string",
"description": "path to log file"
},
"push": {
"$ref": "#/definitions/push"
},
"local": {
"$ref": "#/definitions/local"
},
"meters": {
"$ref": "#/definitions/meters"
}
},
"required": [
"daemon",
"log"
]
} | o21819 |
{
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"properties": {
"cachingMode": {
"description": "Host Caching mode: None, Read Only, Read Write.",
"type": [
"string",
"null"
]
},
"diskName": {
"description": "The Name of the data disk in the blob storage",
"type": [
"string",
"null"
]
},
"diskURI": {
"description": "The URI the data disk in the blob storage",
"type": [
"string",
"null"
]
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": [
"string",
"null"
]
},
"kind": {
"description": "Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"type": [
"string",
"null"
]
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": [
"boolean",
"null"
]
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
} | kb_52_Normalized |
{
"properties": {
"dimensions": {
"properties": {
"base": {
"description": "The base of the triangle (if applicable)",
"type": "number"
},
"height": {
"description": "The height of the triangle (if applicable)",
"type": "number"
},
"radius": {
"description": "The radius of the circle (if applicable)",
"type": "number"
},
"side": {
"description": "The length of the side of the square (if applicable)",
"type": "number"
}
},
"type": "object"
},
"shape": {
"description": "The name of the shape e.g. circle, triangle, square",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_7cd5f218 |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaim": {
"description": "PersistentVolumeClaim is a user's request for and claim to a persistent volume",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"PersistentVolumeClaim"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimSpec",
"description": "Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
},
"status": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimStatus",
"description": "Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
}
},
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "",
"kind": "PersistentVolumeClaim",
"version": "v1"
}
]
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimCondition": {
"description": "PersistentVolumeClaimCondition contails details about state of pvc",
"properties": {
"lastProbeTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Last time we probed the condition."
},
"lastTransitionTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Last time the condition transitioned from one status to another."
},
"message": {
"description": "Human-readable message indicating details about last transition.",
"type": "string"
},
"reason": {
"description": "Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports \"ResizeStarted\" that means the underlying persistent volume is being resized.",
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"status"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimSpec": {
"description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes",
"properties": {
"accessModes": {
"description": "AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1",
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TypedLocalObjectReference",
"description": "This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change."
},
"resources": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements",
"description": "Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"
},
"selector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "A label query over volumes to consider for binding."
},
"storageClassName": {
"description": "Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1",
"type": "string"
},
"volumeMode": {
"description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.",
"type": "string"
},
"volumeName": {
"description": "VolumeName is the binding reference to the PersistentVolume backing this claim.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimStatus": {
"description": "PersistentVolumeClaimStatus is the current status of a persistent volume claim.",
"properties": {
"accessModes": {
"description": "AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1",
"items": {
"type": "string"
},
"type": "array"
},
"capacity": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Represents the actual resources of the underlying volume.",
"type": "object"
},
"conditions": {
"description": "Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimCondition"
},
"type": "array",
"x-kubernetes-patch-merge-key": "type",
"x-kubernetes-patch-strategy": "merge"
},
"phase": {
"description": "Phase represents the current phase of PersistentVolumeClaim.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TypedLocalObjectReference": {
"description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.",
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"type": "string"
},
"kind": {
"description": "Kind is the type of resource being referenced",
"type": "string"
},
"name": {
"description": "Name is the name of resource being referenced",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector": {
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelectorRequirement": {
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ListMeta": {
"description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
"properties": {
"continue": {
"description": "continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.",
"type": "string"
},
"remainingItemCount": {
"_format": "int64",
"description": "remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.",
"type": "integer"
},
"resourceVersion": {
"description": "String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "selfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1",
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type."
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"time": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": "object"
},
"clusterName": {
"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
"type": "string"
},
"creationTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"deletionGracePeriodSeconds": {
"_format": "int64",
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"_format": "int64",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
}
},
"description": "PersistentVolumeClaimList is a list of PersistentVolumeClaim items.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": [
"string",
"null"
]
},
"items": {
"description": "A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaim"
},
"type": [
"array",
"null"
]
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"PersistentVolumeClaimList"
],
"type": [
"string",
"null"
]
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ListMeta",
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
}
},
"required": [
"items"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "",
"kind": "PersistentVolumeClaimList",
"version": "v1"
}
]
} | kb_668_Normalized |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"base_path",
"details",
"document_type",
"publishing_app",
"rendering_app",
"routes",
"schema_name",
"title"
],
"additionalProperties": false,
"properties": {
"access_limited": {
"$ref": "#/definitions/access_limited"
},
"analytics_identifier": {
"$ref": "#/definitions/analytics_identifier"
},
"auth_bypass_ids": {
"description": "A list of ids that will allow access to this item for non-authenticated users",
"$ref": "#/definitions/guid_list"
},
"base_path": {
"$ref": "#/definitions/absolute_path"
},
"bulk_publishing": {
"type": "boolean"
},
"change_note": {
"type": [
"null",
"string"
]
},
"description": {
"$ref": "#/definitions/description_optional"
},
"details": {
"$ref": "#/definitions/details"
},
"document_type": {
"type": "string",
"enum": [
"fatality_notice"
]
},
"first_published_at": {
"$ref": "#/definitions/first_published_at"
},
"last_edited_at": {
"description": "Last time when the content received a major or minor update.",
"type": "string",
"format": "date-time"
},
"links": {
"type": "object",
"additionalProperties": false,
"properties": {
"field_of_operation": {
"$ref": "#/definitions/guid_list",
"maxItems": 1,
"minItems": 1
},
"organisations": {
"description": "All organisations linked to this content item. This should include lead organisations.",
"$ref": "#/definitions/guid_list"
},
"original_primary_publishing_organisation": {
"description": "The organisation that published the original version of the page. Corresponds to the first of the 'Lead organisations' in Whitehall for the first edition, and is empty for all other publishing applications.",
"$ref": "#/definitions/guid_list"
},
"people": {
"description": "People that are associated with this document, typically the person part of a role association",
"$ref": "#/definitions/guid_list"
},
"policy_areas": {
"description": "A largely deprecated tag currently only used to power email alerts.",
"$ref": "#/definitions/guid_list"
},
"primary_publishing_organisation": {
"description": "The organisation that published the page. Corresponds to the first of the 'Lead organisations' in Whitehall, and is empty for all other publishing applications.",
"$ref": "#/definitions/guid_list",
"maxItems": 1
},
"roles": {
"description": "Government roles that are associated with this document, typically the role part of a role association",
"$ref": "#/definitions/guid_list"
}
}
},
"locale": {
"$ref": "#/definitions/locale"
},
"need_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"phase": {
"description": "The service design phase of this content item - https://www.gov.uk/service-manual/phases",
"type": "string",
"enum": [
"alpha",
"beta",
"live"
]
},
"previous_version": {
"type": "string"
},
"public_updated_at": {
"$ref": "#/definitions/public_updated_at"
},
"publishing_app": {
"$ref": "#/definitions/publishing_app_name"
},
"redirects": {
"type": "array",
"additionalItems": false,
"items": {}
},
"rendering_app": {
"$ref": "#/definitions/rendering_app"
},
"routes": {
"$ref": "#/definitions/routes"
},
"schema_name": {
"type": "string",
"enum": [
"fatality_notice"
]
},
"title": {
"$ref": "#/definitions/title"
},
"update_type": {
"$ref": "#/definitions/update_type"
}
},
"definitions": {
"description": {
"type": "string"
},
"absolute_path": {
"description": "A path only. Query string and/or fragment are not allowed.",
"type": "string",
"pattern": "^/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?$"
},
"access_limited": {
"type": "object",
"additionalProperties": false,
"properties": {
"auth_bypass_ids": {
"description": "Deprecated: auth_bypass_ids should be sent as a separate field",
"$ref": "#/definitions/guid_list"
},
"organisations": {
"description": "A list of organisation content ids permitted access to this item",
"$ref": "#/definitions/guid_list"
},
"users": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"analytics_identifier": {
"description": "A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"body": {
"description": "The main content provided as HTML rendered from govspeak",
"type": "string"
},
"change_history": {
"type": "array",
"items": {
"type": "object",
"required": [
"public_timestamp",
"note"
],
"additionalProperties": false,
"properties": {
"note": {
"description": "A summary of the change",
"type": "string"
},
"public_timestamp": {
"type": "string",
"format": "date-time"
}
}
}
},
"description_optional": {
"anyOf": [
{
"$ref": "#/definitions/description"
},
{
"type": "null"
}
]
},
"details": {
"type": "object",
"required": [
"body",
"change_history",
"emphasised_organisations"
],
"additionalProperties": false,
"properties": {
"body": {
"$ref": "#/definitions/body"
},
"change_history": {
"$ref": "#/definitions/change_history"
},
"emphasised_organisations": {
"$ref": "#/definitions/emphasised_organisations"
},
"first_public_at": {
"$ref": "#/definitions/first_public_at"
}
}
},
"emphasised_organisations": {
"description": "The content ids of the organisations that should be displayed first in the list of organisations related to the item, these content ids must be present in the item organisation links hash.",
"type": "array",
"items": {
"$ref": "#/definitions/guid"
}
},
"first_public_at": {
"description": "DEPRECATED. The date the content was first published. Used in details. Deprecated in favour of top level `first_published_at`.",
"type": "string",
"format": "date-time"
},
"first_published_at": {
"description": "The date the content was first published. Automatically determined by the publishing-api, unless overridden by the publishing application.",
"type": "string",
"format": "date-time"
},
"guid": {
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"
},
"guid_list": {
"type": "array",
"items": {
"$ref": "#/definitions/guid"
},
"_uniqueItems": true
},
"locale": {
"type": "string",
"enum": [
"ar",
"az",
"be",
"bg",
"bn",
"cs",
"cy",
"da",
"de",
"dr",
"el",
"en",
"es",
"es-419",
"et",
"fa",
"fi",
"fr",
"gd",
"he",
"hi",
"hr",
"hu",
"hy",
"id",
"is",
"it",
"ja",
"ka",
"kk",
"ko",
"lt",
"lv",
"ms",
"mt",
"nl",
"no",
"pl",
"ps",
"pt",
"ro",
"ru",
"si",
"sk",
"sl",
"so",
"sq",
"sr",
"sv",
"sw",
"ta",
"th",
"tk",
"tr",
"uk",
"ur",
"uz",
"vi",
"zh",
"zh-hk",
"zh-tw"
]
},
"public_updated_at": {
"description": "When the content was last significantly changed (a major update). Shown to users. Automatically determined by the publishing-api, unless overridden by the publishing application.",
"type": "string",
"format": "date-time"
},
"publishing_app_name": {
"description": "The application that published this item.",
"type": "string",
"enum": [
"calculators",
"calendars",
"collections-publisher",
"contacts",
"content-publisher",
"content-tagger",
"email-alert-frontend",
"external-link-tracker",
"feedback",
"frontend",
"government-frontend",
"hmrc-manuals-api",
"info-frontend",
"licencefinder",
"local-links-manager",
"manuals-frontend",
"manuals-publisher",
"maslow",
"performanceplatform-big-screen-view",
"publisher",
"rummager",
"search-admin",
"search-api",
"service-manual-publisher",
"share-sale-publisher",
"short-url-manager",
"smartanswers",
"special-route-publisher",
"specialist-publisher",
"static",
"tariff",
"travel-advice-publisher",
"whitehall"
]
},
"rendering_app": {
"description": "The application that renders this item.",
"type": "string",
"enum": [
"calculators",
"calendars",
"collections",
"content-store",
"email-alert-frontend",
"email-campaign-frontend",
"feedback",
"finder-frontend",
"frontend",
"government-frontend",
"info-frontend",
"licencefinder",
"manuals-frontend",
"performanceplatform-big-screen-view",
"rummager",
"search-api",
"service-manual-frontend",
"smartanswers",
"spotlight",
"static",
"tariff",
"whitehall-admin",
"whitehall-frontend"
]
},
"route": {
"type": "object",
"required": [
"path",
"type"
],
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"type": {
"enum": [
"prefix",
"exact"
]
}
}
},
"routes": {
"type": "array",
"items": {
"$ref": "#/definitions/route"
},
"minItems": 1
},
"title": {
"type": "string"
},
"update_type": {
"enum": [
"major",
"minor",
"republish"
]
}
}
} | o21218 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"name": "Package",
"type": "object",
"additionalProperties": false,
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string",
"description": "Package name, including 'vendor-name/' prefix."
},
"type": {
"description": "Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.",
"type": "string"
},
"target-dir": {
"description": "DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.",
"type": "string"
},
"description": {
"type": "string",
"description": "Short package description."
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"description": "A tag/keyword that this package relates to."
}
},
"homepage": {
"type": "string",
"description": "Homepage URL for the project.",
"format": "uri"
},
"version": {
"type": "string",
"description": "Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes."
},
"time": {
"type": "string",
"description": "Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format."
},
"license": {
"type": [
"string",
"array"
],
"description": "License name. Or an array of license names."
},
"authors": {
"type": "array",
"description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Full name of the author."
},
"email": {
"type": "string",
"description": "Email address of the author.",
"format": "email"
},
"homepage": {
"type": "string",
"description": "Homepage URL for the author.",
"format": "uri"
},
"role": {
"type": "string",
"description": "Author's role in the project."
}
}
}
},
"require": {
"type": "object",
"description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.",
"additionalProperties": {
"type": "string"
}
},
"replace": {
"type": "object",
"description": "This is a hash of package name (keys) and version constraints (values) that can be replaced by this package.",
"additionalProperties": {
"type": "string"
}
},
"conflict": {
"type": "object",
"description": "This is a hash of package name (keys) and version constraints (values) that conflict with this package.",
"additionalProperties": {
"type": "string"
}
},
"provide": {
"type": "object",
"description": "This is a hash of package name (keys) and version constraints (values) that this package provides in addition to this package's name.",
"additionalProperties": {
"type": "string"
}
},
"require-dev": {
"type": "object",
"description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).",
"additionalProperties": {
"type": "string"
}
},
"suggest": {
"type": "object",
"description": "This is a hash of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).",
"additionalProperties": {
"type": "string"
}
},
"config": {
"type": "object",
"description": "Composer options.",
"properties": {
"process-timeout": {
"type": "integer",
"description": "The timeout in seconds for process executions, defaults to 300 (5mins)."
},
"use-include-path": {
"type": "boolean",
"description": "If true, the Composer autoloader will also look for classes in the PHP include path."
},
"preferred-install": {
"type": [
"string",
"object"
],
"description": "The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or a hash of {\"pattern\": \"preference\"}."
},
"notify-on-install": {
"type": "boolean",
"description": "Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true."
},
"github-protocols": {
"type": "array",
"description": "A list of protocols to use for github.com clones, in priority order, defaults to [\"git\", \"https\", \"http\"].",
"items": {
"type": "string"
}
},
"github-oauth": {
"type": "object",
"description": "A hash of domain name => github API oauth tokens, typically {\"github.com\":\"<token>\"}.",
"additionalProperties": {
"type": "string"
}
},
"gitlab-oauth": {
"type": "object",
"description": "A hash of domain name => gitlab API oauth tokens, typically {\"gitlab.com\":\"<token>\"}.",
"additionalProperties": {
"type": "string"
}
},
"disable-tls": {
"type": "boolean",
"description": "Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini."
},
"secure-http": {
"type": "boolean",
"description": "Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using \"Let's Encrypt\" to get a free SSL certificate is generally a better alternative."
},
"cafile": {
"type": "string",
"description": "A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically."
},
"capath": {
"type": "string",
"description": "If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory."
},
"http-basic": {
"type": "object",
"description": "A hash of domain name => {\"username\": \"...\", \"password\": \"...\"}.",
"additionalProperties": {
"type": "object",
"required": [
"username",
"password"
],
"properties": {
"username": {
"type": "string",
"description": "The username used for HTTP Basic authentication"
},
"password": {
"type": "string",
"description": "The password used for HTTP Basic authentication"
}
}
}
},
"store-auths": {
"type": [
"string",
"boolean"
],
"description": "What to do after prompting for authentication, one of: true (store), false (do not store) or \"prompt\" (ask every time), defaults to prompt."
},
"platform": {
"type": "object",
"description": "This is a hash of package name (keys) and version (values) that will be used to mock the platform packages on this machine.",
"additionalProperties": {
"type": "string"
}
},
"vendor-dir": {
"type": "string",
"description": "The location where all packages are installed, defaults to \"vendor\"."
},
"bin-dir": {
"type": "string",
"description": "The location where all binaries are linked, defaults to \"vendor/bin\"."
},
"data-dir": {
"type": "string",
"description": "The location where old phar files are stored, defaults to \"$home\" except on XDG Base Directory compliant unixes."
},
"cache-dir": {
"type": "string",
"description": "The location where all caches are located, defaults to \"~/.composer/cache\" on *nix and \"%LOCALAPPDATA%\\Composer\" on windows."
},
"cache-files-dir": {
"type": "string",
"description": "The location where files (zip downloads) are cached, defaults to \"{$cache-dir}/files\"."
},
"cache-repo-dir": {
"type": "string",
"description": "The location where repo (git/hg repo clones) are cached, defaults to \"{$cache-dir}/repo\"."
},
"cache-vcs-dir": {
"type": "string",
"description": "The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to \"{$cache-dir}/vcs\"."
},
"cache-ttl": {
"type": "integer",
"description": "The default cache time-to-live, defaults to 15552000 (6 months)."
},
"cache-files-ttl": {
"type": "integer",
"description": "The cache time-to-live for files, defaults to the value of cache-ttl."
},
"cache-files-maxsize": {
"type": [
"string",
"integer"
],
"description": "The cache max size for the files cache, defaults to \"300MiB\"."
},
"bin-compat": {
"enum": [
"auto",
"full"
],
"description": "The compatibility of the binaries, defaults to \"auto\" (automatically guessed) and can be \"full\" (compatible with both Windows and Unix-based systems)."
},
"discard-changes": {
"type": [
"string",
"boolean"
],
"description": "The default style of handling dirty updates, defaults to false and can be any of true, false or \"stash\"."
},
"autoloader-suffix": {
"type": "string",
"description": "Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated."
},
"optimize-autoloader": {
"type": "boolean",
"description": "Always optimize when dumping the autoloader."
},
"prepend-autoloader": {
"type": "boolean",
"description": "If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true."
},
"classmap-authoritative": {
"type": "boolean",
"description": "If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false."
},
"github-domains": {
"type": "array",
"description": "A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to [\"github.com\"].",
"items": {
"type": "string"
}
},
"github-expose-hostname": {
"type": "boolean",
"description": "Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname."
},
"gitlab-domains": {
"type": "array",
"description": "A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to [\"gitlab.com\"].",
"items": {
"type": "string"
}
},
"archive-format": {
"type": "string",
"description": "The default archiving format when not provided on cli, defaults to \"tar\"."
},
"archive-dir": {
"type": "string",
"description": "The default archive path when not provided on cli, defaults to \".\"."
}
}
},
"extra": {
"type": [
"object",
"array"
],
"description": "Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.",
"additionalProperties": true
},
"autoload": {
"type": "object",
"description": "Description of how the package can be autoloaded.",
"properties": {
"psr-0": {
"type": "object",
"description": "This is a hash of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.",
"additionalProperties": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
},
"psr-4": {
"type": "object",
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"additionalProperties": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
},
"classmap": {
"type": "array",
"description": "This is an array of directories that contain classes to be included in the class-map generation process."
},
"files": {
"type": "array",
"description": "This is an array of files that are always required on every request."
},
"exclude-from-classmap": {
"type": "array",
"description": "This is an array of patterns to exclude from autoload classmap generation. (e.g. \"exclude-from-classmap\": [\"/test/\", \"/tests/\", \"/Tests/\"]"
}
}
},
"autoload-dev": {
"type": "object",
"description": "Description of additional autoload rules for development purpose (eg. a test suite).",
"properties": {
"psr-0": {
"type": "object",
"description": "This is a hash of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.",
"additionalProperties": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
},
"psr-4": {
"type": "object",
"description": "This is a hash of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.",
"additionalProperties": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
}
},
"classmap": {
"type": "array",
"description": "This is an array of directories that contain classes to be included in the class-map generation process."
},
"files": {
"type": "array",
"description": "This is an array of files that are always required on every request."
}
}
},
"archive": {
"type": [
"object"
],
"description": "Options for creating package archives for distribution.",
"properties": {
"exclude": {
"type": "array",
"description": "A list of patterns for paths to exclude or include if prefixed with an exclamation mark."
}
}
},
"repositories": {
"type": [
"object",
"array"
],
"description": "A set of additional repositories where packages can be found.",
"additionalProperties": true
},
"minimum-stability": {
"type": [
"string"
],
"description": "The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.",
"pattern": "^dev|alpha|beta|rc|RC|stable$"
},
"prefer-stable": {
"type": [
"boolean"
],
"description": "If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages."
},
"bin": {
"type": [
"array"
],
"description": "A set of files that should be treated as binaries and symlinked into bin-dir (from config).",
"items": {
"type": "string"
}
},
"include-path": {
"type": [
"array"
],
"description": "DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.",
"items": {
"type": "string"
}
},
"scripts": {
"type": [
"object"
],
"description": "Scripts listeners that will be executed before/after some events.",
"properties": {
"pre-install-cmd": {
"type": [
"array",
"string"
],
"description": "Occurs before the install command is executed, contains one or more Class::method callables or shell commands."
},
"post-install-cmd": {
"type": [
"array",
"string"
],
"description": "Occurs after the install command is executed, contains one or more Class::method callables or shell commands."
},
"pre-update-cmd": {
"type": [
"array",
"string"
],
"description": "Occurs before the update command is executed, contains one or more Class::method callables or shell commands."
},
"post-update-cmd": {
"type": [
"array",
"string"
],
"description": "Occurs after the update command is executed, contains one or more Class::method callables or shell commands."
},
"pre-status-cmd": {
"type": [
"array",
"string"
],
"description": "Occurs before the status command is executed, contains one or more Class::method callables or shell commands."
},
"post-status-cmd": {
"type": [
"array",
"string"
],
"description": "Occurs after the status command is executed, contains one or more Class::method callables or shell commands."
},
"pre-package-install": {
"type": [
"array",
"string"
],
"description": "Occurs before a package is installed, contains one or more Class::method callables or shell commands."
},
"post-package-install": {
"type": [
"array",
"string"
],
"description": "Occurs after a package is installed, contains one or more Class::method callables or shell commands."
},
"pre-package-update": {
"type": [
"array",
"string"
],
"description": "Occurs before a package is updated, contains one or more Class::method callables or shell commands."
},
"post-package-update": {
"type": [
"array",
"string"
],
"description": "Occurs after a package is updated, contains one or more Class::method callables or shell commands."
},
"pre-package-uninstall": {
"type": [
"array",
"string"
],
"description": "Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands."
},
"post-package-uninstall": {
"type": [
"array",
"string"
],
"description": "Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands."
},
"pre-autoload-dump": {
"type": [
"array",
"string"
],
"description": "Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands."
},
"post-autoload-dump": {
"type": [
"array",
"string"
],
"description": "Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands."
},
"post-root-package-install": {
"type": [
"array",
"string"
],
"description": "Occurs after the root-package is installed, contains one or more Class::method callables or shell commands."
},
"post-create-project-cmd": {
"type": [
"array",
"string"
],
"description": "Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands."
}
}
},
"support": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address for support.",
"format": "email"
},
"issues": {
"type": "string",
"description": "URL to the issue tracker.",
"format": "uri"
},
"forum": {
"type": "string",
"description": "URL to the forum.",
"format": "uri"
},
"wiki": {
"type": "string",
"description": "URL to the wiki.",
"format": "uri"
},
"irc": {
"type": "string",
"description": "IRC channel for support, as irc://server/channel.",
"format": "uri"
},
"source": {
"type": "string",
"description": "URL to browse or download the sources.",
"format": "uri"
},
"docs": {
"type": "string",
"description": "URL to the documentation.",
"format": "uri"
},
"rss": {
"type": "string",
"description": "URL to the RSS feed.",
"format": "uri"
}
}
},
"non-feature-branches": {
"type": [
"array"
],
"description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.",
"items": {
"type": "string"
}
},
"abandoned": {
"type": [
"boolean",
"string"
],
"description": "Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false."
},
"_comment": {
"type": [
"array",
"string"
],
"description": "A key to store comments in"
}
}
} | o6023 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"pathpair": {
"type": "object",
"properties": {
"cloud": {
"type": "string",
"pattern": "(^gs://(.+))|(^http://(.+))|(^https://(.+))"
},
"local": {
"type": "string",
"pattern": "^/(.*)"
}
},
"required": [
"cloud",
"local"
],
"additionalProperties": false
},
"bytesunit": {
"type": "string",
"pattern": "^BYTES|^KB|^MB|^GB|^TB",
"default": "MB"
}
},
"type": "object",
"properties": {
"name": {
"type": "string",
"default": ""
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/pathpair"
}
},
"commandline": {
"type": "string"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/definitions/pathpair"
}
},
"stdout": {
"type": "string",
"pattern": "^gs://(.+)",
"default": ""
},
"stderr": {
"type": "string",
"pattern": "^gs://(.+)",
"default": ""
},
"resources": {
"type": "object",
"properties": {
"cpus": {
"type": "number",
"minimum": 0.1
},
"mem": {
"type": "integer",
"minimum": 1
},
"memunit": {
"$ref": "#/definitions/bytesunit"
},
"disk": {
"type": "integer",
"minimum": 1
},
"diskunit": {
"$ref": "#/definitions/bytesunit"
}
},
"required": [
"cpus",
"mem",
"disk"
]
},
"docker": {
"type": "string"
}
},
"required": [
"inputs",
"commandline",
"outputs",
"resources",
"docker"
]
} | o27402 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "rarIncome",
"description": "Rental income received under the Rent a Room scheme for the period",
"properties": {
"amount": {
"title": "Amount",
"description": "Income associated with the running of the business - Between 0 and 99999999999.99",
"type": "number",
"multipleOf": 0.01,
"minimum": 0,
"maximum": 99999999999.99,
"example": "10000.89"
}
},
"required": [
"amount"
],
"additionalProperties": false
} | o46379 |
{
"properties": {
"dimensions": {
"description": "The dimensions of the shape",
"properties": {
"length": {
"description": "The length of the shape",
"type": "number"
},
"radius": {
"description": "The radius of the shape",
"type": "number"
},
"width": {
"description": "The width of the shape",
"type": "number"
}
},
"required": [
"length",
"width",
"radius"
],
"type": "object"
},
"shape": {
"description": "The shape for which area needs to be calculated",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"type": "object"
} | calculate_area_1fc98eee |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"DestinationCidrBlock": {
"pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/(\\d|[1-2]\\d|3[0-2]))|0\\.0\\.0\\.0\\/0$",
"type": "string"
},
"NatGatewayId": {
"pattern": "^[a-z][a-z0-9\\-]+$",
"type": "string"
},
"RouteTableId": {
"pattern": "^[a-z][a-z0-9\\-]+$",
"type": "string"
}
},
"required": [
"DestinationCidrBlock",
"RouteTableId",
"NatGatewayId"
],
"type": "object"
} | o41033 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"web-dir"
],
"properties": {
"scripts": {
"type": "object",
"description": "This is a hash of script names (keys) and shell commands (values) to execute.",
"additionalProperties": false,
"patternProperties": {
"^([a-z0-9-])+$": {
"type": "string"
}
}
},
"vars": {
"type": "object",
"description": "This is a hash of variable names (keys) and values (values).",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][a-zA-Z_0-9]*$": {
"type": "string"
}
}
},
"web-dir": {
"type": "string",
"description": "Relative directory that contains files to be published as website"
}
}
} | o84043 |
{
"title": "colorModulationInfo",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"description": "Indicates whether modulation should be used to render the point.",
"properties": {
"field": {
"type": "string",
"description": "the attribute to use as a source for the modulation amplitude"
},
"maxValue": {
"type": "number",
"description": "maximum value to compute modulation linear mapping"
},
"minValue": {
"type": "number",
"description": "minimum value to compute modulation linear mapping"
}
},
"required": [
"field",
"maxValue",
"minValue"
],
"additionalProperties": false
} | o90179 |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_batch_v1_JobCondition": {
"description": "JobCondition describes current state of a job.",
"properties": {
"lastProbeTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Last time the condition was checked."
},
"lastTransitionTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Last time the condition transit from one status to another."
},
"message": {
"description": "Human readable message indicating details about last transition.",
"type": "string"
},
"reason": {
"description": "(brief) reason for the condition's last transition.",
"type": "string"
},
"status": {
"description": "Status of the condition, one of True, False, Unknown.",
"type": "string"
},
"type": {
"description": "Type of job condition, Complete or Failed.",
"type": "string"
}
},
"required": [
"type",
"status"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_batch_v1_JobSpec": {
"description": "JobSpec describes how the job execution will look like.",
"properties": {
"activeDeadlineSeconds": {
"_format": "int64",
"description": "Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer",
"type": "integer"
},
"backoffLimit": {
"_format": "int32",
"description": "Specifies the number of retries before marking this job failed. Defaults to 6",
"type": "integer"
},
"completions": {
"_format": "int32",
"description": "Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/",
"type": "integer"
},
"manualSelector": {
"description": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector",
"type": "boolean"
},
"parallelism": {
"_format": "int32",
"description": "Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/",
"type": "integer"
},
"selector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors"
},
"template": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodTemplateSpec",
"description": "Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/"
},
"ttlSecondsAfterFinished": {
"_format": "int32",
"description": "ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.",
"type": "integer"
}
},
"required": [
"template"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_batch_v1_JobStatus": {
"description": "JobStatus represents the current state of a Job.",
"properties": {
"active": {
"_format": "int32",
"description": "The number of actively running pods.",
"type": "integer"
},
"completionTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC."
},
"conditions": {
"description": "The latest available observations of an object's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_batch_v1_JobCondition"
},
"type": "array",
"x-kubernetes-patch-merge-key": "type",
"x-kubernetes-patch-strategy": "merge"
},
"failed": {
"_format": "int32",
"description": "The number of pods which reached phase Failed.",
"type": "integer"
},
"startTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC."
},
"succeeded": {
"_format": "int32",
"description": "The number of pods which reached phase Succeeded.",
"type": "integer"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AWSElasticBlockStoreVolumeSource": {
"description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
},
"partition": {
"_format": "int32",
"description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).",
"type": "integer"
},
"readOnly": {
"description": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\". If omitted, the default is \"false\". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "boolean"
},
"volumeID": {
"description": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Affinity": {
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAntiAffinity",
"description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureDiskVolumeSource": {
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"properties": {
"cachingMode": {
"description": "Host Caching mode: None, Read Only, Read Write.",
"type": "string"
},
"diskName": {
"description": "The Name of the data disk in the blob storage",
"type": "string"
},
"diskURI": {
"description": "The URI the data disk in the blob storage",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"kind": {
"description": "Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureFileVolumeSource": {
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.",
"properties": {
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretName": {
"description": "the name of secret that contains Azure Storage Account Name and Key",
"type": "string"
},
"shareName": {
"description": "Share Name",
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CSIVolumeSource": {
"description": "Represents a source location of a volume to mount, managed by an external CSI driver",
"properties": {
"driver": {
"description": "Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.",
"type": "string"
},
"nodePublishSecretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed."
},
"readOnly": {
"description": "Specifies a read-only configuration for the volume. Defaults to false (read/write).",
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"description": "VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.",
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Capabilities": {
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CephFSVolumeSource": {
"description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"monitors": {
"description": "Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /",
"type": "string"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "boolean"
},
"secretFile": {
"description": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"
},
"user": {
"description": "Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CinderVolumeSource": {
"description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: points to a secret object containing parameters used to connect to OpenStack."
},
"volumeID": {
"description": "volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapEnvSource": {
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapKeySelector": {
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapProjection": {
"description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.",
"properties": {
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapVolumeSource": {
"description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/"
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext",
"description": "Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort": {
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"_format": "int32",
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"_format": "int32",
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIProjection": {
"description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.",
"properties": {
"items": {
"description": "Items is a list of DownwardAPIVolume file",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector",
"description": "Required: Selects a field of the pod: only annotations, labels, name and namespace are supported."
},
"mode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeSource": {
"description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "Items is a list of downward API volume file",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeFile"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EmptyDirVolumeSource": {
"description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.",
"properties": {
"medium": {
"description": "What type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir",
"type": "string"
},
"sizeLimit": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity",
"description": "Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar": {
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVarSource": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EphemeralContainer": {
"description": "An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle",
"description": "Lifecycle is not allowed for ephemeral containers."
},
"livenessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"name": {
"description": "Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.",
"type": "string"
},
"ports": {
"description": "Ports are not allowed for ephemeral containers.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ContainerPort"
},
"type": "array"
},
"readinessProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"resources": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements",
"description": "Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod."
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext",
"description": "SecurityContext is not allowed for ephemeral containers."
},
"startupProbe": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe",
"description": "Probes are not allowed for ephemeral containers."
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"targetContainerName": {
"description": "If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature.",
"type": "string"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction": {
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FCVolumeSource": {
"description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"lun": {
"_format": "int32",
"description": "Optional: FC target lun number",
"type": "integer"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"targetWWNs": {
"description": "Optional: FC target worldwide names (WWNs)",
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"description": "Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlexVolumeSource": {
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.",
"properties": {
"driver": {
"description": "Driver is the name of the driver to use for this volume.",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Extra command options if any.",
"type": "object"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts."
}
},
"required": [
"driver"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlockerVolumeSource": {
"description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.",
"properties": {
"datasetName": {
"description": "Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated",
"type": "string"
},
"datasetUUID": {
"description": "UUID of the dataset. This is unique identifier of a Flocker dataset",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GCEPersistentDiskVolumeSource": {
"description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"partition": {
"_format": "int32",
"description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "integer"
},
"pdName": {
"description": "Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GitRepoVolumeSource": {
"description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.",
"properties": {
"directory": {
"description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.",
"type": "string"
},
"repository": {
"description": "Repository URL",
"type": "string"
},
"revision": {
"description": "Commit hash for the specified revision.",
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GlusterfsVolumeSource": {
"description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"endpoints": {
"description": "EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"path": {
"description": "Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction": {
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPHeader": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler": {
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostAlias": {
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostPathVolumeSource": {
"description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
},
"type": {
"description": "Type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ISCSIVolumeSource": {
"description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.",
"properties": {
"chapAuthDiscovery": {
"description": "whether support iSCSI Discovery CHAP authentication",
"type": "boolean"
},
"chapAuthSession": {
"description": "whether support iSCSI Session CHAP authentication",
"type": "boolean"
},
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi",
"type": "string"
},
"initiatorName": {
"description": "Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.",
"type": "string"
},
"iqn": {
"description": "Target iSCSI Qualified Name.",
"type": "string"
},
"iscsiInterface": {
"description": "iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).",
"type": "string"
},
"lun": {
"_format": "int32",
"description": "iSCSI Target Lun number.",
"type": "integer"
},
"portals": {
"description": "iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "CHAP Secret for iSCSI target and initiator authentication"
},
"targetPortal": {
"description": "iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "The key to project.",
"type": "string"
},
"mode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"path": {
"description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Lifecycle": {
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NFSVolumeSource": {
"description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "boolean"
},
"server": {
"description": "Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeAffinity": {
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelector": {
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement": {
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "The label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.",
"type": "string"
},
"values": {
"description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm": {
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ObjectFieldSelector": {
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimVolumeSource": {
"description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).",
"properties": {
"claimName": {
"description": "ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims",
"type": "string"
},
"readOnly": {
"description": "Will force the ReadOnly setting in VolumeMounts. Default false.",
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PhotonPersistentDiskVolumeSource": {
"description": "Represents a Photon Controller persistent disk resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"pdID": {
"description": "ID that identifies Photon Controller persistent disk",
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinity": {
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm": {
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaces": {
"description": "namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAntiAffinity": {
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfig": {
"description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.",
"properties": {
"nameservers": {
"description": "A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.",
"items": {
"type": "string"
},
"type": "array"
},
"options": {
"description": "A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfigOption"
},
"type": "array"
},
"searches": {
"description": "A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfigOption": {
"description": "PodDNSConfigOption defines DNS resolver options of a pod.",
"properties": {
"name": {
"description": "Required.",
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodReadinessGate": {
"description": "PodReadinessGate contains the reference to a pod condition",
"properties": {
"conditionType": {
"description": "ConditionType refers to a condition in the pod's condition list with matching type.",
"type": "string"
}
},
"required": [
"conditionType"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSecurityContext": {
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"_format": "int64",
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified defaults to \"Always\".",
"type": "string"
},
"runAsGroup": {
"_format": "int64",
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"_format": "int64",
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"_format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSpec": {
"description": "PodSpec is a description of a pod.",
"properties": {
"activeDeadlineSeconds": {
"_format": "int64",
"description": "Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.",
"type": "integer"
},
"affinity": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Affinity",
"description": "If specified, the pod's scheduling constraints"
},
"automountServiceAccountToken": {
"description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
"type": "boolean"
},
"containers": {
"description": "List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"dnsConfig": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodDNSConfig",
"description": "Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy."
},
"dnsPolicy": {
"description": "Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.",
"type": "string"
},
"enableServiceLinks": {
"description": "EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.",
"type": "boolean"
},
"ephemeralContainers": {
"description": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EphemeralContainer"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"hostAliases": {
"description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostAlias"
},
"type": "array",
"x-kubernetes-patch-merge-key": "ip",
"x-kubernetes-patch-strategy": "merge"
},
"hostIPC": {
"description": "Use the host's ipc namespace. Optional: Default to false.",
"type": "boolean"
},
"hostNetwork": {
"description": "Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.",
"type": "boolean"
},
"hostPID": {
"description": "Use the host's pid namespace. Optional: Default to false.",
"type": "boolean"
},
"hostname": {
"description": "Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.",
"type": "string"
},
"imagePullSecrets": {
"description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"initContainers": {
"description": "List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Container"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"nodeName": {
"description": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
"type": "object"
},
"overhead": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.",
"type": "object"
},
"preemptionPolicy": {
"description": "PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.",
"type": "string"
},
"priority": {
"_format": "int32",
"description": "The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.",
"type": "integer"
},
"priorityClassName": {
"description": "If specified, indicates the pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.",
"type": "string"
},
"readinessGates": {
"description": "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodReadinessGate"
},
"type": "array"
},
"restartPolicy": {
"description": "Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy",
"type": "string"
},
"runtimeClassName": {
"description": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14.",
"type": "string"
},
"schedulerName": {
"description": "If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSecurityContext",
"description": "SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field."
},
"serviceAccount": {
"description": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.",
"type": "string"
},
"serviceAccountName": {
"description": "ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
"type": "string"
},
"shareProcessNamespace": {
"description": "Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.",
"type": "boolean"
},
"subdomain": {
"description": "If specified, the fully qualified Pod hostname will be \"<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>\". If not specified, the pod will not have a domainname at all.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"_format": "int64",
"description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.",
"type": "integer"
},
"tolerations": {
"description": "If specified, the pod's tolerations.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Toleration"
},
"type": "array"
},
"topologySpreadConstraints": {
"description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is only honored by clusters that enable the EvenPodsSpread feature. All topologySpreadConstraints are ANDed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TopologySpreadConstraint"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"topologyKey",
"whenUnsatisfiable"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "topologyKey",
"x-kubernetes-patch-strategy": "merge"
},
"volumes": {
"description": "List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Volume"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge,retainKeys"
}
},
"required": [
"containers"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodTemplateSpec": {
"description": "PodTemplateSpec describes the data a pod should have when created from a template",
"properties": {
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodSpec",
"description": "Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PortworxVolumeSource": {
"description": "PortworxVolumeSource represents a Portworx volume resource.",
"properties": {
"fsType": {
"description": "FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"volumeID": {
"description": "VolumeID uniquely identifies a Portworx volume",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PreferredSchedulingTerm": {
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"_format": "int32",
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Probe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"_format": "int32",
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"_format": "int32",
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"type": "integer"
},
"periodSeconds": {
"_format": "int32",
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"type": "integer"
},
"successThreshold": {
"_format": "int32",
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"timeoutSeconds": {
"_format": "int32",
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"type": "integer"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ProjectedVolumeSource": {
"description": "Represents a projected volume source",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"sources": {
"description": "list of volume projections",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeProjection"
},
"type": "array"
}
},
"required": [
"sources"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_QuobyteVolumeSource": {
"description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
"properties": {
"group": {
"description": "Group to map volume access to Default is no group",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.",
"type": "boolean"
},
"registry": {
"description": "Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes",
"type": "string"
},
"tenant": {
"description": "Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin",
"type": "string"
},
"user": {
"description": "User to map volume access to Defaults to serivceaccount user",
"type": "string"
},
"volume": {
"description": "Volume is a string that references an already created Quobyte volume by name.",
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_RBDVolumeSource": {
"description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd",
"type": "string"
},
"image": {
"description": "The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"keyring": {
"description": "Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"monitors": {
"description": "A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"description": "The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
},
"user": {
"description": "The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceFieldSelector": {
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ResourceRequirements": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ScaleIOVolumeSource": {
"description": "ScaleIOVolumeSource represents a persistent ScaleIO volume",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\".",
"type": "string"
},
"gateway": {
"description": "The host address of the ScaleIO API Gateway.",
"type": "string"
},
"protectionDomain": {
"description": "The name of the ScaleIO Protection Domain for the configured storage.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail."
},
"sslEnabled": {
"description": "Flag to enable/disable SSL communication with Gateway, default false",
"type": "boolean"
},
"storageMode": {
"description": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.",
"type": "string"
},
"storagePool": {
"description": "The ScaleIO Storage Pool associated with the protection domain.",
"type": "string"
},
"system": {
"description": "The name of the storage system as configured in ScaleIO.",
"type": "string"
},
"volumeName": {
"description": "The name of a volume already created in the ScaleIO system that is associated with this volume source.",
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretEnvSource": {
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretKeySelector": {
"description": "SecretKeySelector selects a key of a Secret.",
"properties": {
"key": {
"description": "The key of the secret to select from. Must be a valid secret key.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretProjection": {
"description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.",
"properties": {
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretVolumeSource": {
"description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"_format": "int32",
"description": "Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"type": "integer"
},
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_KeyToPath"
},
"type": "array"
},
"optional": {
"description": "Specify whether the Secret or its keys must be defined",
"type": "boolean"
},
"secretName": {
"description": "Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"_format": "int64",
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"_format": "int64",
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"windowsOptions": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ServiceAccountTokenProjection": {
"description": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).",
"properties": {
"audience": {
"description": "Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.",
"type": "string"
},
"expirationSeconds": {
"_format": "int64",
"description": "ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.",
"type": "integer"
},
"path": {
"description": "Path is the path relative to the mount point of the file to project the token into.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_StorageOSVolumeSource": {
"description": "Represents a StorageOS persistent volume resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_LocalObjectReference",
"description": "SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted."
},
"volumeName": {
"description": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.",
"type": "string"
},
"volumeNamespace": {
"description": "VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Sysctl": {
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TCPSocketAction": {
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Toleration": {
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"_format": "int64",
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_TopologySpreadConstraint": {
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"_format": "int32",
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. It's the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. It's a required field. Default value is 1 and 0 is not allowed.",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as \"Unsatisfiable\" if and only if placing incoming pod on any topology violates \"MaxSkew\". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_Volume": {
"description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.",
"properties": {
"awsElasticBlockStore": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AWSElasticBlockStoreVolumeSource",
"description": "AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"
},
"azureDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureDiskVolumeSource",
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."
},
"azureFile": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_AzureFileVolumeSource",
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod."
},
"cephfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CephFSVolumeSource",
"description": "CephFS represents a Ceph FS mount on the host that shares a pod's lifetime"
},
"cinder": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CinderVolumeSource",
"description": "Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"
},
"configMap": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapVolumeSource",
"description": "ConfigMap represents a configMap that should populate this volume"
},
"csi": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_CSIVolumeSource",
"description": "CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature)."
},
"downwardAPI": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIVolumeSource",
"description": "DownwardAPI represents downward API about the pod that should populate this volume"
},
"emptyDir": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_EmptyDirVolumeSource",
"description": "EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"
},
"fc": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FCVolumeSource",
"description": "FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod."
},
"flexVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlexVolumeSource",
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin."
},
"flocker": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_FlockerVolumeSource",
"description": "Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running"
},
"gcePersistentDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GCEPersistentDiskVolumeSource",
"description": "GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"
},
"gitRepo": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GitRepoVolumeSource",
"description": "GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container."
},
"glusterfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_GlusterfsVolumeSource",
"description": "Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md"
},
"hostPath": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_HostPathVolumeSource",
"description": "HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"
},
"iscsi": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ISCSIVolumeSource",
"description": "ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md"
},
"name": {
"description": "Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"nfs": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_NFSVolumeSource",
"description": "NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"
},
"persistentVolumeClaim": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PersistentVolumeClaimVolumeSource",
"description": "PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
},
"photonPersistentDisk": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PhotonPersistentDiskVolumeSource",
"description": "PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"
},
"portworxVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PortworxVolumeSource",
"description": "PortworxVolume represents a portworx volume attached and mounted on kubelets host machine"
},
"projected": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ProjectedVolumeSource",
"description": "Items for all in one resources secrets, configmaps, and downward API"
},
"quobyte": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_QuobyteVolumeSource",
"description": "Quobyte represents a Quobyte mount on the host that shares a pod's lifetime"
},
"rbd": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_RBDVolumeSource",
"description": "RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md"
},
"scaleIO": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ScaleIOVolumeSource",
"description": "ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."
},
"secret": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretVolumeSource",
"description": "Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"
},
"storageos": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_StorageOSVolumeSource",
"description": "StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."
},
"vsphereVolume": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VsphereVirtualDiskVolumeSource",
"description": "VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"
}
},
"required": [
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeDevice": {
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"properties": {
"devicePath": {
"description": "devicePath is the path inside of the container that the device will be mapped to.",
"type": "string"
},
"name": {
"description": "name must match the name of a persistentVolumeClaim in the pod",
"type": "string"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeMount": {
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"type": "string"
},
"name": {
"description": "This must match the Name of a Volume.",
"type": "string"
},
"readOnly": {
"description": "Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VolumeProjection": {
"description": "Projection that may be projected along with other supported volume types",
"properties": {
"configMap": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ConfigMapProjection",
"description": "information about the configMap data to project"
},
"downwardAPI": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_DownwardAPIProjection",
"description": "information about the downwardAPI data to project"
},
"secret": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_SecretProjection",
"description": "information about the secret data to project"
},
"serviceAccountToken": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_ServiceAccountTokenProjection",
"description": "information about the serviceAccountToken data to project"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_VsphereVirtualDiskVolumeSource": {
"description": "Represents a vSphere volume resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"storagePolicyID": {
"description": "Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.",
"type": "string"
},
"storagePolicyName": {
"description": "Storage Policy Based Management (SPBM) profile name.",
"type": "string"
},
"volumePath": {
"description": "Path that identifies vSphere volume vmdk",
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WeightedPodAffinityTerm": {
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"_format": "int32",
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_core_v1_WindowsSecurityContextOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_api_resource_Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelector": {
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_LabelSelectorRequirement": {
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1",
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type."
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"time": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": "object"
},
"clusterName": {
"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
"type": "string"
},
"creationTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"deletionGracePeriodSeconds": {
"_format": "int64",
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"_format": "int64",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_util_intstr_IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Job represents the configuration of a single job.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"enum": [
"batch/v1"
],
"type": [
"string",
"null"
]
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"Job"
],
"type": [
"string",
"null"
]
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_batch_v1_JobSpec",
"description": "Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
},
"status": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_batch_v1_JobStatus",
"description": "Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
}
},
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "batch",
"kind": "Job",
"version": "v1"
}
]
} | kb_478_Normalized |
{
"definitions": {
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_autoscaling_v1_CrossVersionObjectReference": {
"description": "CrossVersionObjectReference contains enough information to let you identify the referred resource.",
"properties": {
"apiVersion": {
"description": "API version of the referent",
"type": "string"
},
"kind": {
"description": "Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\"",
"type": "string"
},
"name": {
"description": "Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_autoscaling_v1_HorizontalPodAutoscalerSpec": {
"description": "specification of a horizontal pod autoscaler.",
"properties": {
"maxReplicas": {
"_format": "int32",
"description": "upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.",
"type": "integer"
},
"minReplicas": {
"_format": "int32",
"description": "minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.",
"type": "integer"
},
"scaleTargetRef": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_autoscaling_v1_CrossVersionObjectReference",
"description": "reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource."
},
"targetCPUUtilizationPercentage": {
"_format": "int32",
"description": "target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.",
"type": "integer"
}
},
"required": [
"scaleTargetRef",
"maxReplicas"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_autoscaling_v1_HorizontalPodAutoscalerStatus": {
"description": "current status of a horizontal pod autoscaler",
"properties": {
"currentCPUUtilizationPercentage": {
"_format": "int32",
"description": "current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.",
"type": "integer"
},
"currentReplicas": {
"_format": "int32",
"description": "current number of replicas of pods managed by this autoscaler.",
"type": "integer"
},
"desiredReplicas": {
"_format": "int32",
"description": "desired number of replicas of pods managed by this autoscaler.",
"type": "integer"
},
"lastScaleTime": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed."
},
"observedGeneration": {
"_format": "int64",
"description": "most recent generation observed by this autoscaler.",
"type": "integer"
}
},
"required": [
"currentReplicas",
"desiredReplicas"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_FieldsV1",
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type."
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"time": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": "object"
},
"clusterName": {
"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
"type": "string"
},
"creationTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"deletionGracePeriodSeconds": {
"_format": "int64",
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time",
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"_format": "int64",
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_OwnerReference": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_Time": {
"_format": "date-time",
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"type": "string"
}
},
"description": "configuration of a horizontal pod autoscaler.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"enum": [
"autoscaling/v1"
],
"type": [
"string",
"null"
]
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"enum": [
"HorizontalPodAutoscaler"
],
"type": [
"string",
"null"
]
},
"metadata": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_apimachinery_pkg_apis_meta_v1_ObjectMeta",
"description": "Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_autoscaling_v1_HorizontalPodAutoscalerSpec",
"description": "behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status."
},
"status": {
"$ref": "#/definitions/https:__kubernetesjsonschema_dev_master__defs_json_defs_io_k8s_api_autoscaling_v1_HorizontalPodAutoscalerStatus",
"description": "current information about the autoscaler."
}
},
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "autoscaling",
"kind": "HorizontalPodAutoscaler",
"version": "v1"
}
]
} | kb_389_Normalized |
{
"properties": {
"customer": {
"properties": {
"email": {
"description": "The email address of the customer",
"type": "string"
},
"name": {
"description": "The name of the customer",
"type": "string"
}
},
"required": [
"name",
"email"
],
"type": "object"
},
"items": {
"items": {
"properties": {
"name": {
"description": "The name of the item",
"type": "string"
},
"price": {
"description": "The price of the item",
"type": "number"
},
"quantity": {
"description": "The quantity of the item",
"type": "integer"
}
},
"required": [
"name",
"quantity",
"price"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"customer",
"items"
],
"type": "object"
} | create_invoice_9a29dec8 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Image schema",
"description": "Description of an image that is available for presentation of a step",
"image": {
"type": "object",
"description": "data about a image",
"properties": {
"filename": {
"type": "string",
"description": "Filename of image in local filesystem"
},
"alt": {
"type": "string",
"description": "Alternative text for image"
}
},
"required": [
"filename"
],
"additionalProperties": false
},
"properties": {
"image": {
"$ref": "#/image"
}
},
"required": [
"image"
]
} | o53035 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://json.schemastore.org/vsix-publish.json",
"properties": {
"identity": {
"type": "object",
"required": ["internalName"],
"properties": {
"description": {
"type": "string",
"title": "Description",
"description": "A description for the extension. Required if the extension is not a VSIX.",
"minLength": 1,
"maxLength": 280
},
"displayName": {
"type": "string",
"title": "DisplayName",
"description": "A display name for the extension. Required if the extension is not a VSIX.",
"minLength": 1,
"maxLength": 80
},
"icon": {
"type": "string",
"title": "Icon",
"description": "An icon for the extension. Required if the extension is not a VSIX. Can be relative to the current json file's directory.",
"minLength": 1
},
"installTargets": {
"type": "array",
"title": "InstallTargets",
"description": "A list of install targets for the extension. At least one is required if the extension is not a VSIX.",
"minItems": 1,
"uniqueItems": true,
"items": {
"title": "InstallTarget",
"description": "An installation target for the extension.",
"type": "object",
"required": ["sku", "version"],
"properties": {
"sku": {
"type": "string",
"title": "Install target SKU",
"description": "The SKU name of the installation target.",
"enum": [
"Microsoft.VisualStudio.Community",
"Microsoft.VisualStudio.Enterprise",
"Microsoft.VisualStudio.Express_All",
"Microsoft.VisualStudio.IntegratedShell",
"Microsoft.VisualStudio.Pro",
"Microsoft.VisualStudio.TestProfessional",
"Microsoft.VisualStudio.Ultimate",
"Microsoft.VisualStudio.Premium",
"Microsoft.VisualStudio.VBExpress",
"Microsoft.VisualStudio.VCExpress",
"Microsoft.VisualStudio.VCSExpress",
"Microsoft.VisualStudio.VPDExpress",
"Microsoft.VisualStudio.VSLS",
"Microsoft.VisualStudio.VSWinExpress",
"Microsoft.VisualStudio.VSWinDesktopExpress",
"Microsoft.VisualStudio.VWDExpress"
]
},
"version": {
"type": "string",
"title": "Install target version range",
"description": "The version range of the install target that the extension can be installed to.",
"pattern": "^[0-9\\[\\(,. \\)\\]]+$"
}
}
}
},
"internalName": {
"type": "string",
"title": "Internal name",
"description": "The internal name of the extension. A marketplace extension is identified as 'publisherName'.'internalName'. Cannot contain spaces.",
"minLength": 1,
"maxLength": 63,
"pattern": "^[^\\s-]+$"
},
"language": {
"type": ["string", "number"],
"title": "Language",
"description": "The default language the extension applies to. Must be a CLR locale code or an lcid code.",
"pattern": "^(\\d{4})$|^([a-zA-Z]{2}(-[A-Za-z]{2})?)$|^neutral$"
},
"tags": {
"type": "array",
"title": "Tags",
"description": "A list of tags for the extension.",
"items": {
"type": "string",
"title": "Tag",
"description": "A tag for the extension.",
"minLength": 1,
"maxLength": 50
}
},
"version": {
"type": "string",
"title": "Version",
"description": "The version of the extension. Required if the extension is not a VSIX.",
"pattern": "^([0-9]+\\.){1,3}([0-9]+)$"
},
"vsixId": {
"type": "string",
"title": "VsixId",
"description": "The vsix identifier of the extension.",
"minLength": 1
}
}
},
"assetFiles": {
"type": "array",
"title": "AssetFiles",
"description": "A list of assets to include in the package sent to the marketplace.",
"items": {
"type": "object",
"required": ["pathOnDisk", "targetPath"],
"properties": {
"pathOnDisk": {
"type": "string",
"title": "PathOnDisk",
"description": "A path to the file to include in the package. Can be relative to the current json file's directory.",
"minLength": 1
},
"targetPath": {
"type": "string",
"title": "TargetPath",
"description": "The path to embed the file in the package. This can be referenced from your overview file via an image link, for example",
"default": ""
}
}
}
},
"categories": {
"type": "array",
"title": "Categories",
"description": "A list of categories that the extension applies to.",
"minItems": 1,
"maxItems": 3,
"uniqueItems": true,
"items": {
"anyOf": [
{
"type": "string",
"title": "Category",
"description": "A valid category on the marketplace that the extension applies to.",
"minLength": 1
},
{
"enum": [
"ajax",
"build",
"coding",
"connected services",
"data",
"database",
"documentation",
"extension sdk",
"framework and libraries",
"lightswitch",
"lightswitch controls",
"lightswitch templates",
"modelling",
"office",
"other",
"other templates",
"performance",
"process templates",
"programming languages",
"reporting",
"scaffolding",
"security",
"services",
"setup and deployment",
"sharepoint",
"sharepoint controls",
"sharepoint templates",
"silverlight controls",
"source control",
"start pages",
"team development",
"testing",
"visual studio extensions",
"wcf",
"web",
"windows forms templates",
"windows forms controls",
"workflow",
"wpf templates",
"wpf controls",
"xna"
]
}
]
}
},
"overview": {
"type": "string",
"title": "Overview",
"description": "A path to a markdown file that will be displayed on the extension's page in the marketplace. The path can be relative to the current json file's path.",
"minLength": 1
},
"priceCategory": {
"type": "string",
"title": "PriceCategory",
"description": "The pricing model for the extension.",
"default": "free",
"enum": ["free", "trial", "paid"]
},
"publisher": {
"type": "string",
"title": "Publisher",
"description": "The publisher of the extension. Must not be a display name of the publisher.",
"minLength": 1
},
"private": {
"type": "boolean",
"title": "Private",
"description": "If true, the extension will be uploaded as a private extension.",
"default": false
},
"qna": {
"type": "boolean",
"title": "Q&A",
"description": "If true, the extension will have a Q&A page on the marketplace.",
"default": true
},
"repo": {
"type": "string",
"title": "Repo",
"description": "A URL that points to the GitHub repo for the extension.",
"format": "uri"
}
},
"required": ["categories", "identity", "overview", "publisher"],
"type": "object"
}
| vsix-publish |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"oneOf": [
{
"type": [
"string",
"null"
],
"format": "non-blank"
},
{
"description": "A piece of legislation. NB we expect to add additional properties to this over time",
"type": "object",
"properties": {
"name": {
"type": "string",
"format": "non-blank",
"description": "name of the the legislation"
},
"url": {
"type": "string",
"format": "non-blank"
}
}
}
]
} | o65455 |
{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "Resolution Rule",
"description": "validation of resolution rules",
"type": "object",
"properties": {
"align": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"group": {
"type": "string"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
},
"match": {
"type": "string"
},
"ruleSet": {
"type": "string"
},
"reason": {
"type": "string"
},
"author": {
"type": "string"
},
"date": {
"type": "string"
}
},
"required": [
"includes",
"excludes",
"reason",
"author",
"date",
"group"
],
"additionalProperties": false
},
"_uniqueItems": true
},
"deny": {
"type": "array"
},
"exclude": {
"type": "array"
},
"reject": {
"type": "array"
},
"replace": {
"type": "array"
},
"substitute": {
"type": "array"
}
},
"required": [
"align",
"deny",
"exclude",
"reject",
"replace",
"substitute"
],
"additionalProperties": false
} | o63181 |
{
"properties": {
"destination": {
"description": "The destination address for shipping",
"type": "string"
},
"dimensions": {
"properties": {
"height": {
"description": "The height of the package in centimeters",
"type": "number"
},
"length": {
"description": "The length of the package in centimeters",
"type": "number"
},
"width": {
"description": "The width of the package in centimeters",
"type": "number"
}
},
"required": [
"length",
"width",
"height"
],
"type": "object"
},
"weight": {
"description": "The weight of the package in kilograms",
"type": "number"
}
},
"required": [
"weight",
"dimensions",
"destination"
],
"type": "object"
} | calculate_shipping_cost_34a93e55 |
{
"title": "fabric info",
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"fabric_fq_name"
],
"properties": {
"fabric_fq_name": {
"type": "array",
"items": {
"type": "string"
}
},
"devices": {
"type": "array",
"description": "List of device names",
"items": {
"type": "string"
}
}
}
} | o71298 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Halfling Model File Definition Schema",
"type": "object",
"required": [
"SubsetMaterialDefinitions"
],
"properties": {
"GenNormals": {
"description": "Post-processing can automatically calculate the mesh normals. If normals already exist, setting GenNormals to true will do nothing",
"type": "boolean"
},
"CalcTangents": {
"description": "Post-processing can automatically calculate the mesh tangents. If tangents already exist, setting CalcTangents to true will do nothing",
"type": "boolean"
},
"VertexBufferUsage": {
"description": "The usage type for the VertexBuffer",
"enum": [
"default",
"immutable",
"dynamic",
"staging"
]
},
"IndexBufferUsage": {
"description": "The usage type for the IndexBuffer",
"enum": [
"default",
"immutable",
"dynamic",
"staging"
]
},
"MaterialDefinitions": {
"description": "The list of all the material definitions for each subset of the model",
"type": "array",
"items": {
"type": "object",
"properties": {
"MaterialName": {
"description": "The name of the subset. This is usually extracted from the source model file",
"type": "string"
},
"HMATFilePath": {
"description": "The file path to the *.hmat file for the material",
"type": "string"
},
"TextureDefinitions": {
"description": "The textures used in the shader. ORDER MATTERS!! They will be fed to the shader in the order that they are specified here",
"type": "array",
"items": {
"type": "object",
"properties": {
"FilePath": {
"description": "The file path to the texture",
"type": "string"
},
"Sampler": {
"description": "The sampler to use with the texture",
"enum": [
"linear_clamp",
"linear_border",
"linear_wrap",
"point_clamp",
"point_wrap",
"anisotropic_wrap"
]
}
}
}
}
},
"minItems": 1,
"additionalItems": false
}
}
}
} | o13402 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.